other countries. Other names may be trademarks of t heir respective owners.
The product described in this document is distributed under licenses restricting its use, copying, distribution, and decompilation/reverse
engineering. No part of this document may be reproduced in any form by any means without prior written authorization of Symantec
Corporation and its licensors, if any.
THE DOCUMENTATION IS PROVIDED “AS IS” AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE
DISCLAIMED, EXCEPT TO THE E XTENT THAT SUCH DISCLAIMERS ARE HELD T O BE LEGALLY INV ALID . SYMANTE C CORPORATION SHALL NOT
BE LIABLE FOR INCIDENTAL OR CONSEQUENTIAL DAMAGES IN CONNECTION WITH THE FURNISHING, PERFORMANCE, OR USE OF THIS
DOCUMENTATION. THE INFORMATION CONTAINED IN THIS DOCUMENTATION IS SUBJECT TO CHANGE WITHOUT NOTICE.
The Licensed Software and Documentation are deemed to be commercial computer software as defined in FAR 12.212 and subject to
restricted rights as defined in FAR Section 52.227-19 “Commercial Computer Software - Restricted Rights” and DFARS 227.7202, “Rights in
Commercial Computer Software or Commercial Computer Software Documentation”, as applicable, and any successor regulations. Any use,
modification, reproduction release, performance, display or disclosure of the Licensed Software and Documentation by the U.S. Government
shall be solely in accordance with the terms of this Agreement.
Symantec Corporation
350 Ellis Street
Mountain View, CA 94043
http://www.symantec.com
WiseScript Package Editor Reference2
Page 3
Technical Support
Symantec Technical Support maintains support centers globally. Technical Support’s
primary role is to respond to specific queries about product features and functionality.
The Technical Support group also creates content for our online Knowledge Base. The
Technical Support group works collaboratively with the other functional areas within
Symantec to answer your questions in a timely fashion. For example, the Technical
Support group works with Product Engineering and Symantec Security Response to
provide alerting services and virus definition updates.
Symantec’s maintenance offerings include the following:
zA range of support options that give you the flexibility to select the right amount of
service for any size organization
zTelephone and Web-based support that provides rapid response and up-to-the-
minute information
zUpgrade assurance that delivers automatic software upgrade protection
zAdvanced features, including Account Management Services
For information about Symantec’s Maintenance Programs, you can visit our Web site at
the following URL:
www.symantec.com/techsupp/
Contacting Technical Support
Customers with a current maintenance agreement may access Technical Support
information at the following URL:
www.symantec.com/techsupp/
Before contacting Technical Support, make sure you have satisfied the system
requirements that are listed in your product documentation. Also, you should be at the
computer on which the problem occurred, in case it is necessary to replicate the
problem.
When you contact Technical Support, please have the following information available:
zProduct release level
zHardware information
zAvailable memory, disk space, and NIC information
zOperating system
zVersion and patch level
zNetwork topology
zRouter, gateway, and IP address informa tion
zProblem description:
Error messages and log files
Troubleshooting that was performed before contacting Symantec
Recent software configuration changes and network changes
WiseScript Package Editor Reference3
Page 4
Licensing and registration
If your Symantec product requires registration or a license key, access our technical
support Web page at the following URL:
www.symantec.com/techsupp/
Customer service
Customer service information is available at the following URL:
www.symantec.com/techsupp/
Customer Service is available to assist with the following types of issues:
zQuestions regarding product licensing or serialization
zProduct registration updates, such as address or name changes
zGeneral product information (features, language availability, local dealers)
zLatest information about product updates and upgrades
zInformation about upgrade assurance and maintenance contracts
zInformation about the Symantec Buying Programs
zAdvice about Symantec’s technical support options
zNontechnical presales questions
zIssues that are related to CD-ROMs or manuals
Maintenance agreement resources
If you want to contact Symantec regarding an existing maintenance agreement, please
contact the maintenance agreement administration team for your region as follows:
Asia-Pacific and Japancustomercare_apac@symantec.com
Europe, Middle-East, and Africasemea@symantec.com
North America and Latin Americasupportsolutions@symantec.com
Additional enterprise services
Symantec offers a comprehensive set of services that allow you to maximize your
investment in Symantec products and to develop your knowledge, expertise, and global
insight, which enable you to manage your business risks proactively.
Enterprise services that are available include the following:
Symantec Early
Warning Solutions
Managed Security
Services
These solutions provide early warning of cyber attacks,
comprehensive threat analysis, and countermeasures to prevent
attacks before they occur.
These services remove the burden of managing and monitoring
security devices and events, ensuring rapid response to real
threats.
WiseScript Package Editor Reference4
Page 5
Consulting
Services
Educational
Services
To access more information about Enterprise services, please visit our Web site at the
following URL:
www.symantec.com
Select your country or language from the site index.
Symantec Consulting Services provide on-site technical
expertise from Symantec and its trusted partners. Symantec
Consulting Services offer a variety of prepackaged and
customizable options that include assessment, design,
implementation, monitoring, and management capabilities. Each
is focused on establishing and maintaining the integrity and
availability of your IT resources.
Educational Services provide a full array of technical training,
security education, security certification, and awareness
communication programs.
zAbout WiseScript on page 12
zWiseScript Benefits on page 13
zGetting Started on page 14
zStarting the Software on page 15
zThe Product Interface on page 16
zUsing WiseScripts in a Windows Installer Installation on page 17
zCompiling, Testing, and Running a WiseScript on page 18
zProduct Documentation on page 19
About WiseScript
WiseScript Package Editor
WiseScript Package Editor is an application development tool for creating and editing
installation packages based on the WiseScript™ scripting language. Use WiseScript
Package Editor to edit and refine installations that you have imported from legacy
installations, or that you have recreated with SetupCapture or ApplicationWatch.
The Installation Expert view in WiseScript Package Editor lets you create and edit basic
installations and provides an easy-to-use, task-oriented user interface to set the most
common installation tasks. Each page of Installation Expert lets you configure a specific
aspect of your installation.
For advanced customization, you can edit the installation script in Script Editor, which
provides a powerful and easy-to-use scripting environment based on the WiseScript™
scripting language. You create and edit lines in the script by setting options in dialog
boxes, which decreases the chances of syntax or other errors.
WiseScript Package Editor is a tool in the Professional Edition of Wise Package Studio.
WiseScript Editor
WiseScript Editor is a WiseScript™ authoring environment that you can use to automate
administrative tasks. You also can use it to create .EXEs to use as custom actions in
Windows Installer installations. These custom actions can extend the capabilities of
Microsoft Windows Installer and simplify installation tasks (example: parsing and
arithmetic functions) that are difficult to accomplish with Windows Installer.
WiseScript Editor is embedded within Windows Installer Editor and appears when you
create a custom action that calls a WiseScript.
WiseScript Editor contains the same scripting interface as WiseScript Package Editor, but
it does not contain the Installation Expert interface or other installation development
WiseScript Package Editor Reference12
Page 13
tools. Therefore, some of the information in this document does not apply to WiseScript
Editor.
WiseScript Benefits
WiseScript is a high-level scripting language that consolidates dozens or hundreds of
lines of code into predefined script actions.
What Makes WiseScript Unique
zEasy to learn
WiseScript supports a point-and-click method of scripting. The script author is
prompted for the parameters needed by each script action, so a script can be
created and tested very quickly. The script is displayed in clear, English-like
statements. For those who need additional flexibility and control, WiseScript
provides advanced features (examples: IF blocks, WHILE loops, UI dialog boxes).
zNo runtime needed
WiseScripts are compiled into self-contained .EXEs that do not require an agent or
runtime files on the destination computer.
zCompact size
A WiseScript .EXE is small in size (about 100 KB). If a script uses any files that may
not be on the destination computer, it can compress those files into the .EXE.
(Example: A script that detects and removes spyware might temporarily install
Kill.exe on the destination computer while the script is running.)
Introduction
zBuilt-in rollback
WiseScripts can be rolled back after they are executed on the destination computer.
zUser interface
WiseScripts can incorporate any type of dialog box to either inform the end user or
prompt for input.
zWiseScript is powerful
In addition to the dozens of predefined actions, WiseScripts can call VBScripts and
DLL functions, making it possible to use any Windows system call.
zWiseScript is fast
Because the WiseScript engine is written in C++, when you build a WiseScript, you
are building a C++ program. A WiseScript executes faster than a VBScript that
performs the same operation.
zWiseScript is extensible
You can streamline your scripting process by creating your own script actions for
tasks that you perform frequently. To create a user-defined action, create a
WiseScript .WSE (project file) and save it in the Actions subdirectory of the
WiseScript product’s installation directory. Your action will be available for use in
future scripts.
WiseScript Examples
In addition to creating installation packages, following are just a few of the tasks you
can accomplish with WiseScript. For samples of some of these scripts, see the article
Performing System Administration Tasks With WiseScripts in the Altiris Knowledgebase
(Article #27374).
zMove files and directories.
WiseScript Package Editor Reference13
Page 14
zModify a machine resource (example: registry key or .INI file).
zLocate and delete a file and its directory (example: to remove a spyware program).
zFree disk space by clearing the Temp directory, the Recycle Bin, or the Internet
cache.
zFind the current Windows version.
zFind and report system information and take action depending on the results.
zMap a network drive.
zCreate, edit, or manage virtual software layers on computers that have the SVS
Driver (Software Virtualization Agent). For details, see the article Using WiseScripts
to Manage and Update Virtual Software Packages in the Altiris Knowledgebase
(article 27373).
zAssign license numbers from a text file.
Getting Started
Following is a broad outline of possible steps for building and distributing an installation:
1. Create a new installation or WiseScript.
Introduction
See Starting the Software on page 15.
2. (WiseScript Package Editor only) Set options on the Installation Expert pages to
create basic installation functionality.
See About Installation Expert on page 36.
3. Edit the script in Script Editor to create advanced installation functionality.
See About Script Editor on page 94 and About WiseScript Actions on page 117.
4. Create or customize dialog boxes.
See About Dialog Boxes on page 201.
5. Test and debug the installation.
See Compiling, Testing, and Running a WiseScript on page 18 and Using the Debug
Commands on page 106.
6. (WiseScript Package Editor only) Explore opti ons for outputting the installation .EXE
file and prepare it for distribution.
See Media on page 60 and WebDeploy on page 81.
7. To create a compiled .EXE, click Compile.
See Compiling, Testing, and Running a WiseScript on page 18.
8. Use the Package Distribution tool to distribute the installation.
See Package Distribution in the Wise Package Studio Help.
WiseScript Package Editor Reference14
Page 15
Starting the Software
WiseScript Editor
The WiseScript Editor interface is embedded within MSI Script in Windows Installer
Editor. This lets you create WiseScripts for Windows Installer custom actions.
In MSI Script, add or double-click a custom action that runs a WiseScript. On the Details
tab of the Run WiseScript dialog box, click Options.
zTo open a blank script, select Create New WiseScript from the button menu.
zTo open an existing script, select Edit Existing WiseScript from the button menu.
You can begin to add or edit script actions. For information on adding script actions, see
Adding an Action to a Script on page 99. For a description of each script action, see
About WiseScript Actions on page 117.
You also can access WiseScript Editor from the Tools tab or Projects tab in Workbench.
This lets you create WiseScripts that can be used alone or within a Windows Installer
custom action.
WiseScript Package Editor
WiseScript Package Editor is an application development tool for creating and editing
installation packages based on the WiseScript™ scripting language.
Introduction
1. In Wise Package Studio, do one of the following:
On the Projects tab, click the Run link to the right of the task or tool associated
with WiseScript Package Editor. The installation associated with the current
project might open by default. This tool might open to a different view based on
command-line options defined in Process Templates Setup.
On the Tools tab, double-click WiseScript Package Editor.
2. Select File menu > New.
The New Installation File dialog box appears.
3. Select one of the following:
Empty Project
Create an installation project file based on the Empty Project.wse installation
template. It contains a default script in which the basic elements of an
installation are already configured.
Project files do not store the files you add to an installation but the paths to the
files. If you move the source files, the paths break. (For information on how to
fix broken paths, see Changing Source Directories on page 28.)
Blank Script
Build an installation or custom .EXE entirely in Script Editor. If you select this,
some pages in Installation Expert are not available.
See Switching Between Installation Expert and Script Editor on page 17.
4. Click OK.
The installation opens, and you can edit it in Installation Expert or Script Editor.
See also:
WiseScript Package Editor Reference15
Page 16
Getting Started
About Installation Expert on page 36
About Script Editor on page 94
Opening a Microsoft SMS Installation
¾ WiseScript Package Editor only
You can open Microsoft SMS files (.IPF) and edit them just as you edit .WSE files. For
information about SMS, search for “SMS” at www.microsoft.com.
1. Select File menu > Open.
The Open dialog box appears.
2. In Files of Type, select SMS Installer Files (*.IPF).
3. Specify the .IPF file.
The installation script appears in Script Editor. Edit and compile the file in the same
manner as a .WSE file.
See also:
Introduction
Starting the Software on page 15
The Product Interface
WiseScript Package Editor has the following views:
zProject Settings
(WiseScript Editor only) The Project Settings view contains several pages that
provide information that is required by certain script actions.
See About the Project Settings View on page 38.
zInstallation Expert
(WiseScript Package Editor only) Installation Expert lets you build an installation by
pointing and clicking to fill out options.
See Using Installation Expert on page 36.
zScript Editor
Script Editor provides a powerful and easy-to-use scripting environment based on
the WiseScript™ scripting language.
See About Script Editor on page 94.
Script Editor lets you develop more complex installations. Also use it to create
powerful .EXEs to use as custom actions in a Windows Installer installation.
To navigate between views, click the navigation tabs at the lower left of the main
window.
The Installation Expert and Script Editor views are interrelated. As you build an
installation using Installation Expert, a script is also created in Script Editor. Example:
When you add a new file to the installation using Installation Expert, a line appears in
the script with installation instructions for that file. When the installation is run, the
script installs the file.
WiseScript Package Editor Reference16
Page 17
Introduction
Switching Between Installation Expert and Script Editor
When you switch between the Installation Expert and Script Editor views, you might see
the following messages:
zThis installation has custom script code, which is incompatible with Installation
Expert. Click Yes to delete your custom code, or No to preserve it. If you click No,
you have access to a limited set of pages in Installation Expert.
This message appears if you create a custom script in Script Editor, then try to
switch to Installation Expert. Click No to preserve the custom script.
zYou are trying to open an installation in Instal lation Expert, which is not compatible
with some custom scripts, so the script will be opened in Script Editor instead.
This message appears if you open a custom script while in Installation Expert view.
To safely view Installation Expert without converting your script, select Edit menu >
Installation Properties from Script Editor, or press Ctrl+Z. When Installation Expert
opens, only the pages that do not affect the script appear.
Additional Interfaces
zThe Tools menu offers specialized tools with which you can start an installation
script.
See About WiseScript Package Editor Tools on page 239.
zThe Compile, Test, Debug, and Run buttons let you test and compile the installation.
See Compiling, Testing, and Running a WiseScript on page 18.
Using WiseScripts in a Windows Installer
Installation
Windows Installer Editor compiles installations into Windows Installer (.MSI) format.
Therefore, it can provide only those capabilities that are provided by the Windows
Installer SDK environment. WiseScript Package Editor provides an additional authoring
environment that has a larger selection of more versatile script actions than those
provided by Windows Installer products.
You can use WiseScript-based .EXEs in the same way that you use functions in .DLLs.
You write the main installation in a Windows Installer product, but when you need to
perform an advanced function, you can create a WiseScript .EXE and call it with a
custom action in the Windows Installer installation.
Creating a WiseScript .EXE has some advantages over writing a custom program to
create an .EXE:
zWiseScript Editor uses predefined, easy -to-use script actions to accomplish common
installation tasks.
zYou can pass Windows Installer properti es in and out of the WiseScript .EXE.
See Get Windows Installer Property on page 169 and Set Windows Installer Property
on page 197.
zYou can evaluate Windows Installer conditions within a WiseScript .EXE.
See Evaluate Windows Installer Condition on page 156.
The disadvantage of using a WiseScript .EXE is that Windows Installer does not know
about or manage system changes performed by a WiseScript .EXE (example: installation
of a file).
WiseScript Package Editor Reference17
Page 18
See Uninstalling Changes Made by a WiseScript in the Windows Installer Editor Help.
If you use a WiseScript .EXE in a Windows Installer installation that will run on Windows
Vista or later operating system, you must specify a manifest file that indicates the run
level for the .EXE.
See Build Settings on page 41.
Compiling, Testing, and Running a WiseScript
T o test an installation, use the Compile, Test, and Run buttons at the bottom of the main
window.
Note
In WiseScript Package Editor, you also can use the Script Editor debugging functions to
test the script.
See Using the Debug Commands on page 106.
zCompile
Click Compile to build a single executable file that contains the ins tallation script as
well as all the files needed for the installation. This is the installation .EXE that you
distribute to end users. If any files are absent or not readable, error messages
appear when compiling.
Introduction
In WiseScript Package Editor, the installation is saved each time you compile unless
you mark the Prompt to Save check box in Preferences.
See Setting Preferences on page 25.
zTest
Click Test to compile and run the installation in test mode. In test mode, the
installation performs all script actions without actually installing or modifying files.
However, if any script lines are dependent on files being installed by previous script
lines, then test mode might fail. Example: If an Install File(s) line copies a ReadMe
to the Temp directory and a second script line tries to open ReadMe, the second
script line fails because the ReadMe is not in the Temp directory.
zRun
Click Run to execute the installation just as it would execute on the destination
computer. Files are installed on your computer and your system is modified.
Creating a Portable Project
You can create a portable WiseScript project that contains all of the fil es in a WiseScript
including its source files. A portable project is a self-extracting .EXE. Use it to:
zEasily move WiseScript projects from one computer to another without having to
copy source files.
zShare WiseScript projects with others, who can then open and edit your WiseScript
with all of its source files.
To create a portable project
1. Select File menu > Create Project Package.
2. Complete the Create Project Package dialog box:
WiseScript Package Editor Reference18
Page 19
Project Name
Enter a name for the portable project. When the portable project .EXE is run, it
extracts the project’s files and puts them in a directory with this name.
Add default scripts that are included in this WiseScript
Mark this to add any default WiseScripts or VBScripts that are included in the
WiseScript. These default scripts are in the WiseScript Editor\Actions or
WiseScript Editor\Include directories. If you have modified these scripts and
they are included in the WiseScript, then you should include them in the project
Password protect the project package
To add password protection to the project, mark this option and then enter and
confirm the password.
3. Click OK.
The Save As dialog box appears.
4. Specify the file name and location for the portable WiseScript project and click Save.
Product Documentation
This 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.
Introduction
Use the following sources of information to learn about this product.
Note
This documentation covers both WiseScript Package Editor and WiseScript Editor.
WiseScript Editor contains the same scripting interface as WiseScript Package Editor, but
it does not contain the Installation Expert interface or other installation development
tools. Therefore, some of the information in this document does not apply to WiseScript
Editor.
Online Help
The online help contains detailed technical information and step-by-step instructions for
performing common tasks.
Access help in the following ways:
zTo display context-sensitive help for the active window or dialog box, press F1.
zTo select a help topic from a table of contents, index, or search, select Help menu >
Help Topics.
Reference Manual
All the material in the online help is also available in a .PDF-format reference manual,
which you can access by selecting Help menu > Re ference Manual.
Getting Started Guide
The Getting Started Guide contains system requirements and installation instructions.
You can access a .PDF version of the Getting Started Guide from the Windows Start
menu.
WiseScript Package Editor Reference19
Page 20
Introduction
Release Notes
The product release notes cover new features, enhancements, bug fixes, and known
issues for the current version of this product. T o access the release not es, select Release
Notes from the Symantec program group on the Windows Start menu.
WiseScript Package Editor Reference20
Page 21
Chapter 2
Setting Up
This chapter includes the following topics:
zHow to Customize Your Development Environment on page 21
zCreating and Editing Installation Templates on page 22
zCustomizing Installation Expert Page Groups on page 23
zEditing Installation Messages on page 24
zSetting Preferences on page 25
zDownloading Application Runtimes on page 26
How to Customize Your Development Environment
¾ WiseScript Package Editor only
You can do the following to customize your development environment:
zCreate your own installation templates so that each time you create a new
installation, options you set frequently are already pre-configured.
See Creating and Editing Installation Templates on page 22.
zChange the page groups by either selecting a pre-defined view of page groups or
creating your own view.
See Customizing Installation Expert Page Groups on page 23.
zChange prompts and error messages displayed by the installation.
See Editing Installation Messages on page 24.
zSet preferences.
See Setting Preferences on page 25.
zSet the actions list in Script Editor to display only those actions you use most
frequently and add your own actions to the list.
See Customizing the List of Actions on page 97 and Creating a User-Defined Action
on page 102.
zChange the dialog boxes that display during installation by editing default dialog
boxes.
See Editing Dialog Box Templates on page 203.
Note
This documentation covers both WiseScript Package Editor and WiseScript Editor.
WiseScript Editor contains the same scripting interface as WiseScript Package Editor, but
it does not contain the Installation Expert interface or other installation development
tools. Therefore, some of the information in this document does not apply to WiseScript
Editor.
WiseScript Package Editor Reference21
Page 22
Creating and Editing Installation Templates
¾ WiseScript Package Editor only
When you create a new installation, it gets its configuration from a template file.
Templates contain logical defaults and commonly used settings. Some template files are
predefined and appear when you create a new installation. You also can create your own
templates.
Examples:
zIf all your installations have the same system configuration requirements and
document file extensions, you can create a template with these changes
preconfigured.
zIf your installations require a language that is not pre-translated, you can add
translated custom dialog boxes to a template to make the dialog box translations
available to future installations.
Warning
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.
Setting Up
Template Location
Templates are stored in the WiseScript Editor\Template subdirectory of this product’s
installation directory.
To create a custom template
1. Select File menu > New.
The New Installation File dialog box appears.
2. Select Empty Project and click OK.
3. Make all the changes that should appear in installations that will be created with this
template.
4. Save the file:
a. Select File menu > Save As.
b. Name the file and save it in the Template directory as a .WSE.
5. To test the new template, select File menu > New.
The New Installation File dialog box appears and includes the template you just
created. If the New Installation File dialog box does not contain the new template,
verify that you saved it in the Templates directory.
6. Select the template you just created and click OK.
7. Verify that the changes you made in the template are present in this new
installation.
See also:
Language Support on page 31
WiseScript Package Editor Reference22
Page 23
Customizing Installation Expert Page Groups
¾ WiseScript Package Editor only
By default, Installation Expert displays all page groups and all pages within each group.
From the Pages menu, you can select one of the following page groups:
zAll
Displays all page groups and all pages associated with each group.
zProperties
Displays only the pages that do not add or change script lines in the script. This
page group also appears when you select Script Editor > Edit menu > Installation
Properties.
You can add page groups to the Pages menu. This lets you customize your work
environment so you only see the pages you frequently use. You can edit any set of page
groups you create, but not the predefined sets. You also cannot edit page names.
Buttons to edit page groups
and pages are unavailable
when a predefined page
view is selected in Name.
Setting Up
These pages appear under
These pages appear under
the group selected in Page
the group selected in Page
Groups.
Groups.
The page groups appear on
the left side of Installation
Expert.
To add a page group
1. Select Pages menu > Customize.
The Customize Pages dialog box appears.
2. From Name, select <new>.
3. On the dialog box that appears, specify a name for the new set of page groups.
Include an & before a letter to set it as a keyboard shortcut.
The name appears in the Name drop-down list.
4. To add a new page group, click the Add button on the left and specify a name for
the page group.
The name appears in the Page Groups list.
5. To add a page to a page group, select the page group, and click the Add button on
the right.
The Select Pages to Add dialog box appears.
WiseScript Package Editor Reference23
Page 24
6. Select the page or pages and click OK.
7. Add more page groups and pages as appropriate.
8. Click OK.
Your new set of page groups appears under the Pages menu.
Editing Installation Messages
¾ WiseScript Package Editor only
You can edit the prompts and error messages that are displayed by an installation.
Installation messages are stored in wise.ini, which is in the WiseScript Editor
subdirectory of this product’s installation directory. Changes that you make to
installation messages become available to all installations. To back up the installation
messages before editing them, back up wise.ini.
When you add multiple-language support to an installation, you can edit or add
installation messages in languages other than English. Messages are provided for the
following pre-translated languages: English, French, German, Italian, and Spanish . To
add support for any other language, obtain translations of the message text and enter
the translated strings on the Installer Messages dialog box.
Setting Up
For information on adding language support to an installation, see Language Support on
page 31.
To edit installation messages
1. Select Edit menu > Installer Messages.
The Installer Messages dialog box appears.
2. Complete the dialog box:
Language Name
Select the language for which you will edit messages.
Translated Name
The name of the language as it will appear in installations that you create.
Language Code
A three-letter code that matches the Windows-defined language to WiseScript
Package Editor.
See Windows Language Codes on page 254.
Messages
Select the message to edit. You can edit as many of the messages as
necessary.
Message Text
Enter or edit the message.
If you select a language that is not predefined, the messages are in English.
Select Language Dialog
WiseScript Package Editor Reference24
When end users run an installation that supports multiple languages, the Select
Language dialog box appears first, where they select a language. Changes that
you make in these fields apply to all languages.
Page 25
Dialog Title
The title of the Select Language dialog box.
Dialog Text
This text appears on the Select Language dialog box. If the installation
supports multiple languages, enter instructions in all supported languages.
Setting Preferences
¾ WiseScript Package Editor only
In Preferences, customize options for script development and compiling. Also specify
.DLLs to ignore for ApplicationWatch and the Import Visual Basic Project tool.
1. Select Edit menu > Preferences.
2. Complete the Preferences dialog box:
Prompt to Save
Mark this to have Script Editor prompt you to save the installation script each
time you build a new installation .EXE. If you do not mark this check box, the
script is always saved before compiling.
Setting Up
Prompt for Changed Compiler Variables
Mark this to receive a warning if the compiler variables _WISE_ or _ODBC32_
have changed from th e last time the installation script was opened.
Example: If you develop an installation script in which the WiseScript Editor
installation directory is C:\Wise, the compiler variable _WISE_ is set to C:\Wise.
If you then open the same script on a different computer , where the installation
directory is C:\Program Files\Wise, then you are prompted to redefine the
compiler variable _WISE_ to the new WiseScript Editor application location.
Compiler variables are set on the Compiler Variables page.
Add Associated Icons and Registry Keys
If you mark this, when you add a file on the Files page in Installation Expert,
icons and registry keys that are associated with that file are added also.
Append New Script Lines
If you mark this, when you add a new script action in Script Editor, it is inserted
after the currently selected script line, rather than before.
Listbox Compatible Mode
If your computer has certain video drivers, you might have problems selecting
items from list boxes within WiseScript P ackage Editor. If items y ou select from
list boxes are continually misinterpreted, mark this check box to eliminate list
box problems.
Create Backup Copy During Save
Mark this to create a new backup file every time you sa ve. The backup file name
consists of the current file name plus a number. (Example: If the current file
name is Application.wse, the backups are Application1.wse, Application2.wse,
and so on.) Use caution with this option because a new file is created every time
you save.
WiseScript Package Editor Reference25
This option can also be set from Wise Package Studio Preferences; use this
check box to override the Wise Package Studio setting.
Page 26
Setting Up
Show Tabs for Wise Include Scripts
Mark this to show tabs for include scripts in Script Editor.
Color Selection
Select the colors for the types of script actions recognized by Script Editor.
Select the type of script action and then click Set Color to select the color.
Suppress Version Error
Mark this to suppress errors that normally occur when version checking is
performed on files that do not have version resources.
Background Processing
Mark this to allow other applications to run during compile. This slows compiling
by about 50%. If this is cleared, user input is ignored during compile.
Smart Create
Mark this to compile the installation .EXE whenever any file in the installation
changes. If this is marked, the time you wait after clicking the Run button
increases slightly because the compiler checks the modified dates and sizes of
all files in the installation to determine if they have changed. Mark this check
box only when testing and clear it for the final build.
Fast Create
Mark this to speed compiling by copying the compressed version of a file from
the previous version of the installation .EXE to the new one. If the size or date
of a file has changed, it is recompressed. Mark this check box only when testing
and clear it for the final build.
Run in Manual Mode
Mark this to have the installation .EXE prompt for the locations of all directories
to be used for installations (example: Windows, System, and so on) whenever
the installation is run from within WiseScript Package Editor.
Shared Directory
Normally, user-defined actions are stored in the WiseScript Package Editor
Actions directory. Use this field to specify an additional directory to hold userdefined actions. This can be a local or shared network directory. The actions
stored in this directory appear in the Actions list in Script Editor in addition to
the ones in the Actions directory.
System .DLLs to Exclude
Enter the names of .DLL and .OCX files that should not be included when you
create a .WSE file with ApplicationWatch or Import VB Project. Enter one file
name on each line with no other delimiter. Example: If you are watching a
Visual Basic application, you could ignore VBRUN300.DLL because that file is
accessed by Visual Basic applications, but is not necessarily installed with the
Visual Basic application.
Downloading Application Runtimes
¾ WiseScript Package Editor only
The Download Runtimes wizard provides an easy way to get runtime files or runtime
installations that you plan to deploy with your application. You can also use this wizard
to download updates to runtimes you currently have. The ru ntime versions are free, and
you can download as many as you need.
WiseScript Package Editor Reference26
Page 27
Setting Up
If you need to go through a firewall or proxy server to get to the Internet, the Download
Runtimes wizard uses your browser’s proxy settings. To change your Internet
connection settings, refer to your browser’s documentation.
To download application runtimes
1. Connect to the Internet.
2. Select Help menu > Download Runtimes.
The Check for Updates page appears.
3. Click Next on the Check for Updates page.
The Select Runtimes page appears. This lists the runtimes you currently have
installed, and lists all the runtimes that are available for downloading.
4. On the Select Runtime page, mark the check box for each runtime you want to
download. You can click Select All to sel ect all the runtimes, or click Clear All to clear
your selections. As you mark check boxes, the Download Size field displays the
total size of the files you selected.
5. When you finish selecting runtimes, click Next.
The Start Update Download page appears.
6. Click Next to begin the download.
The selected runtime updates are downloaded from the Internet and installed in the
appropriate Wise runtime directory. When the download is finished, the Update
Complete page appears.
7. Click Finish.
WiseScript Package Editor Reference27
Page 28
Chapter 3
Installation Management
This chapter includes the following topics:
zChanging Source Directories on page 28
zConverting to UNC-Based Source File Paths on page 29
zConverting to Relative Source File Paths on page 29
zUsing Self-Repair on page 30
zLanguage Support on page 31
zDistributing an Installation on page 34
Changing Source Directories
Note
This documentation covers both WiseScript Package Editor and WiseScript Editor.
WiseScript Editor contains the same scripting interface as WiseScript Package Editor, but
it does not contain the Installation Expert interface or other installation development
tools. Therefore, some of the information in this document does not apply to WiseScript
Editor.
¾ WiseScript Package Editor only
As you work on an installation, paths to files in the installation can become note valid if
you:
zMove files that are part of the installation to a new directory on your computer or
network.
zMove the installation file itself from your computer to another computer.
zUse relative paths and then move the installation file.
zRename a directory.
If the paths are not valid, then during compile, error messages warn that files cannot be
opened. Rather than adding the files again, you can specify the new source directories
for these files.
1. Select Edit menu > Source Directories.
The Change Source Directories dialog box appears and lists all the directories
referenced in the script.
2. Select a directory in the list.
It appears in the New Pathname field.
3. Edit the path so it points to the new location of the files.
WiseScript Package Editor Reference28
Page 29
Installation Management
As you edit, the new path appears to the right of the original path in the list box. If
you have moved the entire directory tree that contains the installation files, you
might only need to edit the root directory to change all the references.
4. Mark Change Sub-Directories to update the paths of the subdirectories of the
selected directory.
5. When you finish editing directories, click OK.
All parts of the installation that reference these directories are updated.
Converting to UNC-Based Source File Paths
¾ WiseScript Package Editor only
You can convert the mapped drive paths of source files to UNC-based (Uniform Naming
Convention) paths. This helps prevent compile errors when installation source files are
on a central file server.
Example: If you add files to a script from your Y:\ drive, which is mapped to a file
server, the paths in the installation begin with Y:\. If a co-worker opens and compiles
the script on a computer that doesn’t have its Y:\ drive mapped to the same file server,
the compile fails because the script cannot find the source files on the Y:\ drive.
However, if you first convert all network paths to UNC-based paths, co-workers on the
same network can open and compile the script 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 Edit menu > Source Directories.
The Change Source Directories dialog box appears and lists all the directories
referenced in the script.
2. From Type, select Change source paths to UNC paths.
3. Click OK. This action cannot be undone.
A one-time conversion of all the network paths in a script is performed. Paths to files
that are on local drives are not converted. All network files you add subsequently are
converted to UNC-based paths.
If you later change Type to Do not modify source paths, the converted paths stay
converted, but new files you add do not have UNC-based paths.
Converting to Relative Source File Paths
¾ WiseScript Package Editor only
You can convert the paths of source files to relative paths. You might do this to keep all
your source files in a central version and source control system. (Example: Microsoft
Visual SourceSafe. In Microsoft Visual SourceSafe, if you copy the installation files to a
different directory each time you do a Get, you can use this feature to ensure that the
paths are always valid, even though the directory structure changes.)
A relative path uses .\ to indicate the current directory, and it uses ..\ to indicate one
directory up. All paths are relative to where the .WSE file is located.
WiseScript Package Editor Reference29
Page 30
Example: If the path to the .WSI is C:\Development\Application.wsi, and you add the
file C:\Program Files\Application.ini, the relative path of Application.ini is ..\Program
Files\Application.ini.
1. Select Edit menu > Source Directories.
The Change Source Directories dialog box appears and lists all the directories
referenced in the script.
2. From Type, select Change source paths to relative paths.
3. Click OK. This action cannot be undone.
A one-time conversion of the paths in the script is performed. Paths to files that are not
on the same drive as the script file are not converted, because they cannot be written as
relative paths. All files you add subsequently are converted to relative paths.
If you later change Type to Do not modify source paths, the converted paths stay
converted, but new files you add do not have relative paths.
Using Self-Repair
¾ WiseScript Package Editor only
Installation Management
You can enable an application to repair itself. You can implement repair in either of two
ways:
zThrough the uninstall wizard, which is included in every installation you create.
zThrough automatic self-repair, which requires you to define files and registry entries
that are crucial to the application. When these files or registry entries are absent
and the application is started by means of its shortcut, a self-repair process is
started.
Self-repair can only be run under the same user account under which the application
was originally installed. During self-repair, the installation re-edits the registry, re-edits
or recreates .INI files, reinstalls all files, and re-self-registers files. Self-repair works
only if the destination computer is running a Win32 operating system.
Application Repair Run by the End User
Every installation you create contains a repair option that is available to the end user as
part of the uninstall wizard.
To run this repair option, the end user selects the application in the Add/Remove
Programs Control Panel and selects the R epair option. If files need to be reinstalled, the
end user is prompted for the media or network location of the original installation.
Configuring an Application for Automatic Self-Repair
You can configure an y installation y ou create for automatic self-repair. The advantage of
automatic self-repair is that it does not depend on the end user to start it. Whenever the
end user starts the application by means of its shortcut, files and registry entries that
you specify are checked. If they are missing, the end user is prompted to repair the
application. If files need to be reinstalled, the e nd user is prompted for the media or
network location of the original installation.
1. Determine the files and registry entries that are crucial for the application to run
properly.
WiseScript Package Editor Reference30
Page 31
Installation Management
These files and registry keys are checked when the application starts, so limit the
number of items to prevent the start time from increasing.
2. Designate each of these files and registry entries for self-repair as follows:
File: Double-click the file on the Files page or double-click the Install File(s)
script line that references the file. On the Install File Settings dialog box, mark
Repair application if this file is missing.
Registry entry: Do either of the following:
Double-click the value in the lower-right list box on the Registry page and
mark Repair application if this registry value is missing on the dialog
box that appears.
In Script Editor, multiple registry values are contained in one Edit registry
keys script line. Double-click the Edit registry keys script line, navigate to
the required registry value and select it. Mark Repair application if this registry value is missing.
3. Create a shortcut that runs the application, either on the Shortcuts page in
Installation Expert or with the Create Shortcut script action in Script Editor. On the
Shortcut Details dialog box, mark Check self-repair items when this shortcut is opened.
See Shortcuts on page 72 or Create Shortcut on page 142.
When the application is installed, the list of required items is written to a special registry
key. When the end user clicks the shortcut that runs the application, the shortcut runs
unwise.exe (the uninstall program) with special command-line options. Unwise.exe
checks that the required items are present. If they are, unwise.exe opens the
application. The end user does not see this, and if the number of required items is few,
the extra time to start is negligible. If the required items are not present, unwise.exe
displays a message that the application is damaged, and asks whether to repair it, run it
anyway, or stop checking it at startup.
Language Support
¾ WiseScript Package Editor only
You can add language support to an installation, which provides the text in the
installation’s user interface elements in a different language. It does not translate your
application or any user interface elements that you customize in the installation.
You add language support on the Languages page. When an end user runs an
installation that supports multiple languages, the Select Language dialog box appears
first, and prompts the user to select a language. Subsequent installation messages and
dialog boxes appear in the selected language.
To add language support, you use the Languages page, the Installer Messages dialog
box, and custom dialog boxes.
See Processes for Adding Language Support on page 32.
What Languages Are Supported?
You can add support for as many as 15 different languages to a single installation.
WiseScript Package Editor contains the following pre-translated languages in addition to
English: French, German, Italian, Spanish. If the language you need is not one of the
WiseScript Package Editor Reference31
Page 32
pre-translated languages, you can add it to the Languages page and add tr anslated text
for that language. Then you can add support for the new language to the installation.
Example: You want to translate an installation into Swiss French. However, that
language is not one of the pre-translated languages. 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 installation messages and dialog
boxes.
Double-Byte Languages
Some languages (example: Chinese, Japanese, and Korean) require double-byte
character sets, in which each character is represented by two bytes.
WiseScript Package Editor supports double-byte languages. However, if you add support
for a double-byte language, do not add any other languages. I ncluding double-byt e and
single-byte languages in the same installation can cause distortion of the fonts for the
single-byte languages. If you need both single and double-byte installations, make a
copy of the installation and include the double-byte languages in the copy.
Processes for Adding Language Support
¾ WiseScript Package Editor only
Installation Management
You can add language support to an installation, which provides the text in the
installation’s user interface elements in a different language.
Adding Language Support for a Pre-Translated Language
1. In Installation Expert > Languages page, add the language and mark its check box.
See Languages on page 58.
2. If you have added custom dialog boxes to the installation, provide translations for
those dialog boxes.
See step 3 in Adding Language Support for a New Language.
3. If you have changed the text for any installation messages, provide updated
translations for those messages.
See Editing Installation Messages on page 24.
Adding Language Support for a New Language
1. Use the Installer Messages dialog box to add translations of installation messages
for the new language. This also adds the language to the list of languages that are
available on the Languages page.
Changes that you make to installation messages become available to all
installations.
See Editing Installation Messages on page 24.
2. In Installation Expert > Languages page, add the language and mark its check box.
See Languages on page 58.
3. Provide translations for dialog boxes in the installation.
a. In Script Editor, select the language from the Language drop-down list. This
WiseScript Package Editor Reference32
list is populated with the languages that are marked on the Languages page.
Page 33
Installation Management
b. In the script, double-click the Custom Dialog action that references the dialog
box you are changing. (Use Edit menu > Find to find the action quickly.)
c.Edit the dialog box text and controls, replacing the existing text with the text in
the selected language.
See Editing Dialog Boxes on page 203.
d. Repeat these steps for all dialog boxes in the installation.
Note
The dialog box name that appears in the Custom Dialog script action always appears
in English. This information is not displayed to the end user.
4. Provide translations for every script line that presents text to the end user:
a. In Script Editor, select the language from the Language drop-down list. This
list is populated with the languages that are marked on the Languages page.
b. In the script, double-click the script action that contains text. (Use Edit menu >
Find to find the action quickly.)
c.Replace the existing text with the text in the selected language.
5. If necessary, translate the uninstall dialog boxes.
See Translating the Uninstall Dialog Boxes.
Text for the uninstall dialog boxes is stored in text files in the WiseScript
Editor\Language subdirectory of this product’s installation directory. The threeletter language codes are used as the file extensions.
Note
Change s that you make to dialog boxes and script action text are added to the current
installation only. To make the dialog box translations available to future installations,
add them to an installation template instead of to a specific installation.
See Creating and Editing Installation Templates on page 22.
Translating the Uninstall Dialog Boxes
Text for the uninstall dialog boxes is stored in text files in the WiseScript Package
Editor\Language subdirectory of this product’s installation directory.
To add text for a new language
1. Send a copy of the English file (Unwise.eng) to your translator.
2. 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.
3. Rename the translated file, using the three-letter language code as the file
extension. Example: Unwise.frs for Swiss French.
4. Place the translated file in the Languages directory.
See also:
Windows Language Codes on page 254
WiseScript Package Editor Reference33
Page 34
Distributing an Installation
¾ WiseScript Package Editor only
When you complete and compile an installation, you can use Package Distribution to
share or deploy it by:
zCopying a Package to the Share Point Directory
zCopying a Package to a Network Directory
zCopying a Compiled Installation to an FTP Server
See these topics in the Wise Package Studio Help.
Installation Management
WiseScript Package Editor Reference34
Page 35
Chapter 4
Creating WiseScript Installations
This chapter includes the following topics:
zAbout Installation Expert on page 36
zActive Directory on page 38
zAdd/Remove Programs on page 39
zBillboards on page 40
zBuild Settings on page 41
zCAB Files on page 44
zCompiler Variables on page 44
zComponents on page 46
zDialogs on page 46
zDigital Signature on page 47
zFile Associations on page 49
zFiles on page 50
zFonts on page 55
zGeneral Information on page 55
zINI Files on page 56
zInstallation Log on page 58
zLanguages on page 58
zMedia on page 60
zMicrosoft SMS on page 60
zODBC on page 61
zOnline Registration on page 62
zPassword on page 62
zProduct Details on page 63
zProgress Bar on page 63
zRegistry on page 64
zRuntimes on page 68
zScreen on page 69
zServices on page 70
zShortcuts on page 72
zSmartPatch on page 74
WiseScript Package Editor Reference35
Page 36
zSystem Requirements on page 75
zSystem Search on page 77
zUninstall on page 80
zWebDeploy on page 81
zWiseUpdate on page 84
About Installation Expert
The Installation Expert view in WiseScript Package Editor lets you create and edit basic
installations and provides an easy-to-use, task-oriented user interface to perform the
most common installation tasks. Each page of Installation Expert lets you configure a
specific aspect of your installation.
In Installation Expert, the pages are organized into logical groups and listed in the order
in which you usually use them. For quick reference, the pages are arranged
alphabetically.
See Using Installation Expert on page 36.
Installation Expert does not appear in the embedded WiseScript Editor interface.
However, several Installation Expert pages are needed to provide support for certain
WiseScript actions:
Creating WiseScript Installations
zCompiler Variables
zDigital Signature
zGeneral Information
These pages are provided in the Project Settings view.
See About the Project Settings View on page 38.
Note
This documentation covers both WiseScript Package Editor and WiseScript Editor.
WiseScript Editor contains the same scripting interface as WiseScript Package Editor, but
it does not contain the Installation Expert interface or other installation development
tools. Therefore, some of the information in this document does not apply to WiseScript
Editor.
Using Installation Expert
¾ WiseScript Package Editor only
To access Installation Expert, click Installation Expert at the bottom of the WiseScript
Package Editor main window.
WiseScript Package Editor Reference36
Page 37
Creating WiseScript Installations
Page Groups
Page Area
Compile, Test, and RunView Navigation
Page Groups
Pages are organized into 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.
You can create a customized view of page groups and pages.
See Customizing Installation Expert Page Groups on page 23.
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 only
the pages that are pertinent to your particular installation, in any order. If required
information is missing, an error message appears during compile.
zUse on the toolbar to navigate from page to page, or click the page name in
the list of pages.
zTo display help for the current page, press F1.
zTo return a page to its last saved state, select Edit menu > Reset Page.
View Navigation
Click these tabs to change views.
WiseScript Package Editor Reference37
Page 38
Compiling and Testing
Compile, Test, Debug, and Run buttons test and compile the WiseScript.
See also:
About Installation Expert on page 36
About the Project Settings View
¾ WiseScript Editor only
The Project Settings view contains several pages that provide information that is
required by certain script actions. (Example: The Compiler Variable If action requires a
compiler variable to be defined on the Compiler Variables page.)
Project Settings is available only in WiseScript Editor.
T o access Project Set tings, click Project Settings at the lower left of the WiseScript Editor
main window.
The Project Settings view works just like Installation Expert.
Creating WiseScript Installations
See Using Installation Expert on page 36.
Active Directory
¾ WiseScript Package Editor only
Use the Active Directory page to create a .ZAP file. You need a .ZAP file to distribute
.EXEs through Microsoft Active Directory. The .ZAP file is created in the same directory
as the installation .EXE. Microsoft Active Directory uses the information in the .ZAP file
to distribute the .EXE.
Before you complete the Active Directory page, complete the Product Details and Add/
Remove pages. Some of the fields on the Active Directory page obtain their values from
fields on those pages.
Select Installation Expert > Active Directory page and complete the page:
zDo Not Create Zap File During Compile
Mark this to create an installation without a .ZAP file.
zCreate Zap File During Compile
Mark this to add a .ZAP file to the installation and enable the following fields:
Friendly Name
Command Line
This field obtains its value from the Installation Title field on the Product
Details page.
(Optional) Enter a command line to apply to the installation .EXE.
WiseScript Package Editor Reference38
Several command-line options are available.
See WiseScript Installations Command-Line Options on page 257.
Page 39
Display Version
(Optional) This field obtains its value from the Software Version field on the
Add/Remove programs page.
Publisher
(Optional) This field obtains its value from the Publisher field on the Add/
Remove Programs page.
To distribute the .ZAP file with the installation using Package Distribution in Workbench,
select Network and Compiled package on the Distribution Method page. If you
distribute the installation to the share point directory and import it into Software
Manager, the installation and the .ZAP file are copied to the share point Available
Packages directory when you change its status to Available.
Add/Remove Programs
¾ WiseScript Package Editor only
Windows operating systems have an Add/Remove Programs or Programs and Features
applet that let end users uninstall, change, or repair programs. Use the Add/Remove
Programs page to enter the information necessary to support these capabilities.
Creating WiseScript Installations
Select Installation Expert > Add/Remove Programs page and complete the page:
zDisplay Icon
Select an icon to appear next to the application name in the Add/Remove Programs
window. Click Browse to select a file from the installation.
zIcon Number
Enter the resource index for the icon in the selected .EXE or .DLL file.
Note
An executable or icon file can contain multiple icons. To see the icons in a file, go to
Windows Explorer, right-click any shortcut file, and select Properties. Click the
Shortcut tab, then click Change Icon. The Change Icon dialog box appears. It
contains a graphical list of icons for the file. The icon number of the first icon is 0,
the icon number for the second is 1, and so on.
zHide Change/Remove button
Mark this to disable the Change and Rem ove buttons in the Add/ Remove P rograms
control panel. If these buttons are disabled, the end user cannot remove this
program using Control Panel.
zPublisher
Enter the name of the company that makes the application.
zContact 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.
zPhone Number
Enter the phone number of the contact person specified above.
zOnline Support URL
Enter a URL where end users can get online support for the application.
zSoftware Version
Enter the version number of the application.
WiseScript Package Editor Reference39
Page 40
Billboards
Creating WiseScript Installations
zHelp URL
Enter the path to a help file that will be installed on the destination computer.
zComments
Enter any additional comments for the end users.
¾ WiseScript Package Editor only
Use the Billboards page to add billboard graphics to display during installation. The page
lists the billboards in the order they appear during the installation. Use these graphics to
inform end users of software features, to remind them to register the application, or to
advertise related products.
Guidelines for Using Billboard Graphics
zBillboard graphics must be .BMP (bitmap) files.
zAll color palettes are supported. However, large color images decrease installation
speed.
zThe destination computer must be set to display true colors in order for true color
billboards to display correctly.
zIf you simultaneously display multiple color images that use different color palettes,
the colors might not appear correctly.
To add a billboard
1. Select Installation Expert > Billboards page.
2. Click Add at the right of the page and specify the billboard graphic file.
The billboard is added to the list on the Billboards page.
3. Double-click the billboard.
The Billboard Settings dialog box appears.
4. Complete the dialog box:
Pathname
Specify the full path to the image file on your computer. To use variables in this
field, you must mark the Local Graphic option below.
X Position / Y Position
Indicate the location on a 640 x 480 screen to place graphics. On larger
screens, the billboard is placed proportionately based on the 640 x 480 location.
Erase Num
Enter how many previously displayed graphics are erased before this graphic is
displayed. To display one graphic at a time, set this to 1. To display all graphics
simultaneously, set this to 0. The oldest graphic is removed first.
Build Effect
Select a transition effect.
Transparent
WiseScript Package Editor Reference40
Mark this to have pure blue (R=0, G=0, B=255) parts of the graphic become
transparent.
Page 41
Creating WiseScript Installations
Center Horizontal
Place at Right
Scale to Screen
Mark this for the graphic to cover the same percentage of the screen regardless
of screen size.
Hide Progress Bar
Mark this to hide the progress bar during graphic display.
Center Vertical
Place at Bottom
Tile Background
Mark this to repeat the graphic edge-to-edge to fill the entire screen.
Erase All
Mark this to remove all previous graphics from the screen before displaying the
new one.
Timed Display
Mark this to display a series of graphics at evenly-spaced intervals, which is
calculated by the number of files to be installed. This is marked by default and
should remain marked for billboards to work correctly.
5. Click OK.
The end user sees the billboards in the order in which they appear on the Billboards
page. To rearrange billboards, click Move Up and Move Down at the right of the page.
See also:
Display Billboard on page 147
Build Settings
¾ WiseScript Package Editor only
Use the Build Settings page to specify options for compiling the WiseScript and to
specify a manifest file for WiseScripts that will run on Windows Vista or later operating
system.
Note
If the billboards display too quickly during installation, mark the Slow
Installation Speed check box on the Build Settings page.
Local Graphic
Normally, you specify graphic files on your computer, which are then compiled
into the installation. Mark this to specify a file from the destination computer.
With this option, you can use variables in the Pathname field above. Example:
%INST% to indicate the directory from which the installation .EXE is running.
Use this to change g rap hics without rebuilding the .EXE.
Select Installation Expert > Build Settings page and complete the page:
WiseScript Package Editor Reference41
Page 42
Creating WiseScript Installations
zMaximum Compression
Mark this to make the compiled installation file as small as possible. Because it
takes longer to compile with maximum compression, disable this during
development.
zSlow Installation Speed
Mark this to slow down the installation on the destination computer. Do this when
you have a short installation to ensure that your billboard graphics are displayed.
zUse Internal 3D Effects
This option is unavailable because it is no longer used.
zNo Reboot Message During Silent Installs
Normally, when an installation runs silently, it displays a message that the system
must be restarted after installation. Mark this to suppress the warning message and
to restart the system without warning. You can run an installation silently by
running it from the command line and adding a /s option.
zCreate Windows Me System Restore Snapshots
Mark this to have the installation add system snapshot entries to the Windows
Millennium (Me) System Restore utility. This lets end users restore their system to
the state it was in before the application’s installation. The installation takes longer
to perform when this is marked. This works only if you enable it in the Windows Me
operating system.
zReplace In-Use Files
Mark this to have the installation force the replacement of in-use files by performing
a restart of the system. Otherwise, the end user is notified that the installation
cannot be completed and the installation aborts.
zConvert CD-ROM to Floppy
When creating a CD-based installation, you can use the Copy Local Files script
action to copy files from the CD to the end user’s hard disk, rather than embedding
these files in the installation .EXE. Mark this to have these files included in the
installation .EXE so the installation can be placed on floppy disk(s). (Y ou can exclude
individual Copy Local Files script actions from conversion by marking their Don’t
Convert To Floppy check box.
See Copy Local File(s) on page 137.
zBeep on New Disk Prompt
Mark this to cause the compiled installation to beep when requesting a new disk.
zZIP Compatible
Mark this to make the compiled installation compatible with the ZIP archive format.
If you make the installation ZIP compatible, end users can extr act files from it using
any unzip utility, such as WinZip. They must open the installation by selecting File
menu > Open in the ZIP utility. Double-clicking the installation starts it normally.
zNetwork Installation
Mark this if you are creating a network installation and want to reduce network
traffic. If this is marked, a CRC (Cyclic Redundancy Check) is performed on existing
files. If the file exists and is identical to the new installation file, the file is not copied
down, reducing traffic. However, because CRC checks are time-intensive, this can
slow down the installation, so limit this option to installations that are performed
without end user intervention.
Pathnames
For the fields below, click Browse to simplify path and file selection.
WiseScript Package Editor Reference42
Page 43
Creating WiseScript Installations
zInstallation .EXE Name
Specify a name and location for storing the executable file after it is compiled. Leave
this blank to have the name of the installation executable default to the name of the
installation file (*.WSE).
zLanguage .INI Name
To use a language that is not built into WiseScript Package Editor, specify the path
to an .INI file that contains translation resources.
zSetup Icon Pathname
You can leav e this blank to use the default icon file. If you speci fy your own icon file,
you should use an icon file that has the following six icon modes.
Three sizes: 16 X 16, 32 X 32, and 48 X 48
Two colors for each size: 16 and 256 color mode.
zDialogs Directory
If you created a directory containing customized versions of dialog boxe s and dialog
box templates, specify the path to that directory.
zTemp. Files Directory
Specify the path to a directory to store temporary files in while building the
installation. If this directory is not specified, the Windows temporary directory is
used.
Manifest File
If this WiseScript is intended to run on Windows Vista or later operating system, or if
you will use this WiseScript in a Windows Installer installation that will run on Windows
Vista or later operating system, complete this section to specify a manifest file that
indicates the run level for the .EXE at run time. The manifest file is embedded in the
.EXE during compile.
zAdd a predefined manifest file for a specific run level
Select one of the following options to add a predefined manifest for the user level
you specify.
When you start a new WiseScript as a blank script (which is typically a custom
action), this defaults to asInvoker. When you start a new WiseScript as an empty
project (which is typically an installation), this defaults to requireAdministrator.
asInvoker
Select this option for a WiseScript that runs as a custom action in an .MSI. The
WiseScript runs with the level of the user who runs the .MSI. This prevents
failure of the .MSI due to UAC prompting on the custom action execution.
If the WiseScript performs an action that requires elevation, then place the
custom action in the Execute Deferred sequence between the InstallInitialize
and InstallFinalize actions. This lets the action run with elevated privileges .
However, if the user who runs the .MSI does not have elevated privileges, then
the WiseScript will fail and cause the .MSI installation to fail.
highestAvailable
Select this option for a WiseScript installation only, typically one that runs
differently depending on the level of the user. If an administrator runs the .EXE,
the UAC prompt appears. If a standard user runs the .EXE, the UAC prompt
does not appear and the .EXE runs as a standard user.
WiseScript Package Editor Reference43
Do not select this option for a WiseScript custom action.
Page 44
CAB Files
Creating WiseScript Installations
requireAdministrator
Select this option for a WiseScript installation only. When the WiseScript
installation is run, the UAC prompt appears.
Do not select this option for a WiseScript custom action. If you do, the .MSI
installation will fail due to UAC prompting on the custom action execution.
zSpecify a manifest file
To embed a specified manifest file in the .EXE instead of the default manifest, select
this option and specify a manifest file that is in XML format.
For details on manifests and UAC, search for “Application Manifest” and “User Account
Control” in the MSDN Library (msdn.microsoft.com/library/).
¾ WiseScript Package Editor only
Use the CAB Files page to place the compiled .EXE into a cabinet (.CAB) file for
automatic download and installation from a Web page. For information about .CAB files,
search for “cabinet files” and “internet component download” on the Microsoft Web site
(www.microsoft.com).
Select Installation Expert > CAB Files page and complete the page:
zPlace installation .EXE in .CAB File
Mark this to generate a SETUP.INF file that contains instructions for calling the
Microsoft CAB wizard and for copying files to the .CAB file. The SETUP .INF file is part
of the .CAB file, not in the directory structure.
zOptional SETUP.INF Contents
(Optional) Enter or paste additional .INF file instructions for running the application.
Compiler Variables
Use the Compiler Variables page to set compiler variables that change the WiseScript
during compile. You can use compiler variables to include or exclude portions of script
from the compiled .EXE or to build a debug version of the WiseScript.
You set the default v alue of compiler v ariables on the Compiler Variables page, and then
you select the compiler variables in the Compiler Variable If action in Script Editor.
Compiler variables are surrounded by % characters in the script. (Example:
%_DEBUG_%)
You can change the value of compiler variables when you compile.
The sample script Compvar.wse uses compiler variables. For details on sample scripts,
see ScriptHelp.htm in the Samples subdirectory of this product’s installation directory.
The Compiler Variable Settings dialog box appears.
3. Complete the dialog box:
Variable Name
Enter the name of the compiler variable. By convention, compiler variables
begin and end with an underscore character (_). Although this convention is not
enforced, it helps distinguish compiler variables from regular variables in
scripts.
Default Value
Enter the default value of the compiler variable.
Description
Briefly describe how the variable is used. This appears on the dialog box when
you are asked to choose a value for the variable.
Value List
For compiler variables that are displayed as a list, enter a list of valid values,
each on a separate line.
See also Building a Debug Version on page 107
Data Entry Type
Select the method to use to enter data for the compiler variable.
Creating WiseScript Installations
Do Not Prompt for Value
If this is marked, you are not prompted for the value of this variable when
compiling even if Prompt for Compiler Variables is marked on the Compiler
Variables page. Mark this for variables that you do not expect to change
frequently.
4. Click OK.
5. On the Compiler Variables page, mark one of the following:
Compiling from Command Line
Mark this to be prompted for the value of compiler variables when you compile
from the command line. Use this for automated build processes. You can specify
compiler variable values by entering the value directly on the command line or
by storing the values in a text file.
See Command-Line Options on page 256.
Compiling from Within Wise
Mark this to be prompted for the value of compiler variables when you compile
from WiseScript Package Editor. If you mark this, then a Select Compile
Settings dialog box appears during compile and lists this compiler variable’s
values. A dialog box appears for each compiler variable you define. Value length
is limited by the amount of text that displays on the dialog box. The Do not prompt for value check box on the Compiler Variable Settings dialog box
overrides this setting.
See also:
Automatic Compiler Variables on page 245
WiseScript Package Editor Reference45
Page 46
Components
Creating WiseScript Installations
¾ WiseScript Package Editor only
Use the Components page to add components, which are optional pieces, such as a spell
checker, a tutorial, sample files, and other add-ons. When the WiseScript runs, end
users can select the components to install.
Components that you create appear elsewhere in Installation Expert to let you assign
specific resources to components. Example: when you add a shortcut, you can specify
which component it belongs to. The shortcut is installed only if the component it bel ongs
to is installed.
If you use components, you must add files to each component on the Files page.
The sample script Compvar.wse builds a component-based installation. For details on
sample scripts, see ScriptHelp.htm in the Samples subdirectory in this product’s
installation directory.
Note
When an end user selects one or more optional components to be installed, a letter
corresponding to each component is placed in a variable called COMPONENTS . Selecting
the first component places an “A” in the variable, the second adds a “B,” and so on. You
can add up to 26 components this way. You can edit the installation script and use
conditional statements to determine which files are installed when each component is
selected.
Dialogs
To add a component
Select Installation Expert > Components page, click Add at the right of the page, and
complete the Component Details dialog box:
zComponent Name
Enter the component name.
zInstall This Component By Default
Mark this to have the component appears to the end user, who can install it or
deactivate it.
The end user sees the component in the order in which they appear on the Components
page. To rearrange components, click Move Up and Move Down at the right of the page.
¾ WiseScript Package Editor only
Use the Dialogs page to view, activate, and edit the dialog boxes that appear to end
users during installation. The dialog boxes you activate determine the level of control
the end user has over the installation. The predefined dialog boxes are:
zWelcome
zReadMe
Displays the ReadMe file for the application. When you select this dialog box, the
Pathname field is enabled in the Settings section where you specify the .TXT file
for the Readme text.
WiseScript Package Editor Reference46
Page 47
Creating WiseScript Installations
zBranding/Registration
Prompts for the end user’s name, company name, and, optionally, a serial number.
zDestination Directory
Lets the end user choose a destination directory for the installation. The directory
the end user chooses is stored in the variable %MAINDI R %.
zBackup Replaced Files
Lets the end user choose whether to back up files that are replaced during the
installation and where to store the backups.
zSelect Components
Lets the end user choose which optional components to install.
zSelect Icon Group Name
Lets the end user choose the group name for icons installed in Program Manager or
Start menu.
zStart Installation
Gives the end user a final chance to cancel the installation before installation begins.
zFinished
To activate a dialog box
Mark the check box next to the name of the dialog box.
To edit dialog box details and attributes
1. Mark the check box next to the name of the dialog box and click Edit.
2. In the Custom Dialog Editor, edit the dialog.
See About Dialog Boxes on page 201.
The changes you make affect only the dialog boxes in this WiseScript.
To add a dialog box
Click the Add button and complete the Dialog Box Properties dialog.
See Setting Dialog Box Properties on page 204.
Digital Signature
Use the Digital Signature page to add an Authenticode digital signature to an installation
file so its integrity and authenticity can be verified.
Digital signature methods
The file signing tool that is used to digitally sign a file depends on the type of your digital
certificate:
zPublic/private key pair files
This method requires a credentials file (.SPC or .CER) and a private key file (.PVK).
This method is supported by the signcode.exe tool. For details, search for
“Signcode” in the MSDN Library (msdn.microsoft.com/library/).
zPersonal Information Exchange file
This method requires a Personal Information Exchange file (.PFX), which is a
container file for the public/private key information. This method is supported by the
WiseScript Package Editor Reference47
Page 48
Creating WiseScript Installations
signtool.exe tool. For details, search for “Signtool” in the MSDN Library
(msdn.microsoft.com/library/).
Requirements
zYou must have a valid code signing certificate, which you can obtain from a
commercial certificate authority such as V e ri sign. F or a list of certificate authorities,
search for “Microsoft Root Certificate Program Members” in the MSDN Library
(msdn.microsoft.com/library/).
zYou must have the signtool.exe or signcode.exe tool on your computer.
zSigntool.exe requires the CAPICOM 2.0 redistributable to be installed and registered
on your computer. CAPICOM provides services for digitally signing applications, and
is available from the Microsoft Web site.
zThe location of signtool.exe or signcode.exe must be added to your Path
environment variable.
To add a digital signature
(WiseScript Package Editor) Select Installation Expert > Digital Signature page and
complete the page.
(WiseScript Editor) Select Project Settings > Digital Signature and complete the page.
zAdd a digital signature externally
Mark this to leave space in the installation for a digital signature without actually
adding it to the installation. This is useful if the installation must be digitally signed
under a higher security environment by a different individual. Extra space is
reserved to allow for the digital signature information. If an installation does not
have extra space (approximately 5 K), and a digital signature is added, errors occur
when CRC checks are performed because of the resulting size increase. This option
eliminates those errors.
zAdd a digital signature
Mark this to add a digital signature to the installation and to enable the following
fields:
Web URL
Enter your company’s Web site address.
Descriptive Name
Enter the name of your application. This name is embedded in your
Authenticode certificate to let end users verif y the na me of the application they
are installing.
TimeStamp URL
Specify the URL you use for your timestamping service. Timestamping lets end
users distinguish between a certificate that has 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 on
your computer to build the installation but does not need to be available to the
end user running the installation.
zCertificate options
Signtool.exe with Personal Information Exchange file
WiseScript Package Editor Reference48
Mark this to use signtool.exe and then specify the Personal Information
Exchange file (.PFX) to use.
Page 49
Signcode.exe with public/private key pair files
File Associations
¾ WiseScript Package Editor only
Use the File Associations page to associate file ex tensions with executables to determine
which application to start when the end user double-clicks a file with a certain extension.
You can associate file extensions with any executable file in an installation. File
associations are a type of advertising and are stored in the registry.
2. Click Add at the bottom of the page.
The Select File from Installation dialog box appears, which displays directories and
.EXE files from this installation.
3. At the bottom of the dialog box, enter the three-character extension that is
associated with the program.
Creating WiseScript Installations
Mark this to use signcode.exe and then specify the credentials file (.SPC or
.CER) that contains your Digital ID, and your private key file (.PVK).
4. Navigate to and select the .EXE to associate with this file type.
5. Click OK.
The new file association appears on the File Associations page.
To edit an existing file association, double-click it.
See Editing File Association Details.
If you chose an .EXE file that is part of an optional installation component, the
association is created only if that component is installed.
2. Double-click a file association.
The Association Details dialog box appears.
3. Complete the dialog box:
Document Extension
Enter the three-character extension that is associated with the program.
Document Identifier, Identifier Full Name
Identify the program that can open files of the type listed in the Document
Extension field.
Print Options
WiseScript Package Editor Reference49
Enter the command-line options to be passed to the application to cause it to
print the file instead of just opening it. This adds a Print command to the rightclick menu for files of that document type.
Page 50
Files
Creating WiseScript Installations
Source Pathname
(Read-only) This is the path to the .EXE program associated with the specified
document extension.
4. Click OK.
See also:
File Associations on page 49
¾ WiseScript Package Editor only
Use the Files page to specify the files and directories to be installed on the destination
computer. When you add files, Installation Expert does not actually copy or store the
files, but records the location of the files. The files are not copied until you compile and
build the installation. Therefore, if you change a file’s name or location, you must update
its path, otherwise you get error messages when you compile.
See Changing Source Directories on page 28.
When you add a program file to the Files page, Installation Expert searches the registry
for related information, such as file associations and icons. This information is added to
corresponding Installation Expert pages.
Note
If you inadvertently add multiple instances of the same file (with the same path), only
one copy is compiled into the installation .EXE. Use Script Editor > Edit menu >
Duplicate Files Report, to find duplicate files.
Working With the Files Page
The upper two list boxes display the directories and files available to your computer. The
lower two list boxes represent the directory structure and files that will be installed on
the destination computer.
zDrag directories or files to the page from Windows Explorer.
zDrag directories or files from the upper list boxes to the lower list boxes.
zUse the following buttons:
Add Contents
Add entire directories. When you add an entire directory you can filter it using
wildcards.
See Adding Contents of Directories on page 52.
Add File
Add single or multiple files.
New Folder
Delete Folder, Delete File
WiseScript Package Editor Reference50
See Adding Files on page 51.
Create directories to be installed on the destination computer.
Remove a directory or file from the installation.
Page 51
Adding Files
Creating WiseScript Installations
Details
Edit file settings.
See Specifying Installation File Settings on page 53.
¾ WiseScript Package Editor only
1. Select Installation Expert > Files page.
2. If the directory where the file is to be added is not listed in the lower-left list box:
Select the directory under which the new directory should be created.
Click New Folder, enter a directory name, and click OK.
3. In the lower-left list box, select the directory to which the file will be added.
You must assign all files to either the Application directory , a Windows directory , or a
subdirectory that you create. If the installation contains more than one component,
the list box contains directories for each component.
Application directory
This represents the default installation directory for the program. This is where
the executables, ReadMe files, and other non-system files are typically
assigned.
Windows directory
System level files, such as fonts and certain .DLLs, should be assigned to the
appropriate Windows directory. The main system directories are already
created, and you can add new ones.
4. In the upper-left list box select the directory containing the file or files to add.
The files in this directory are listed in the upper-right list box.
5. From the upper-right list box, select the files to added to the destination directory:
To add a single file to the destination directory, double-click the file.
To add multiple files, select them and click Add File.
6. To add the contents of an entire directory or to use wildcard filters to add only
specified files in the directory, select the directory in the upper-right list box and
click Add Contents. Complete the fields on the Add Wildcards dialog box and click
OK.
See Adding Contents of Directories on page 52.
7. Repeat the preceding steps to add all application files.
You can also drag files from Windows Explorer and drop them in a directory under the
Destination Computer icon. When you drop the file, the Drag and Drop Settings dialog
box opens so you can set file properties (this is the same as the Install File Settings
dialog box.) To confirm the file’s location, click OK.
To review file assignments, select a destination directory in the lower-left list box. All
files assigned to that directory are listed in the lower-right list bo x. To remove a file from
the installation, select it in the lower-ri ght list box, and click Delete File. To set advanced
installation options for a particular file, double-click it in the lower-right list box. This
opens the Install File Settings dialog box.
WiseScript Package Editor Reference51
Page 52
See Specifying Installation File Settings on page 53.
If you assign files to a directory that is part of an optional instal lation component, those
files are installed only if that component is installed.
Adding Contents of Directories
¾ WiseScript Package Editor only
You can add the ent ire con tents of a direct ory to an installation or use wildcard filters to
add only specified files in the directory.
1. Select Installation Expert > Files page.
2. In the upper-left list box, select the directory whose contents you want to add.
3. In the lower-left list box, select the directory where you want to add the contents.
4. Click Add Contents.
The Add Wildcards dialog box appears.
5. Complete the Add Wildcards dialog box:
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-left list box.
Creating WiseScript Installations
Include Wildcard, Exclude Wildcard
T o include or ex clude files based on specific criteria, enter a semicolon-delimited
list of wildcards. (Example: Enter *.EXE for all .EXE files or *.DLL for .DLL files.)
If you leave the wildcard fields blank, all files in the directory are added.
Include Subdirectories
Mark this to add all the subdirectories within the directory you’re adding. The
wildcard settings apply to the subdirectories also.
Add as a wildcard instead of adding the files
Mark this to have the lower-right list box display wildcard settings (as specified
in the Include Wildcard field or *.* if no wildcards are specified) instead of the
actual file names. This lets you add other files to the source directory later.
When the installation is compiled, all files matching the wildcard filter are copied
to the destination computer. With this option, the program does not
automatically create icons and file associations.
6. 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 specified wildcards, only files that match the wildcard criteria
are added.
See also:
Specifying Installation File Settings on page 53
Adding Files on page 51
WiseScript Package Editor Reference52
Page 53
Specifying Installation File Settings
¾ WiseScript Package Editor only
1. Select Installation Expert > Files page.
2. In the lower-right list box, select a file or files and click Details.
If you selected a single file, the Install File Settings dialog box appears. If you
selected multiple files, the Multiple File Settings dialog box appears.
3. Complete the dialog box:
Source Pathname
Specify the path of the file on your computer.
Destination Pathname
Specify the path the file will have on the destination computer. Use variables to
start the path (example: %MAINDIR%\Dev\File.txt). This field has a drop-down
list with common variables. Do not include wildcards in this field.
Description
Enter text to appear in the progress bar while this file is installed.
Require Password
If you entered a password on the Password page, and you mark this, the end
user is prompted for the password before this file is installed.
Creating WiseScript Installations
The password prompt appears only once, for the first password-protected file in
an installation, regardless of the number of password-protected files. If no
password-protected files are slated for installation, the prompt does not appear.
Include Sub-Directories
If you specify a dir e ctory in Source Pathname, mark this to include all
subdirectories and their contents.
Shared DLL Counter
If this is marked, and the file is a .DLL or .VBX, Windows tracks the file to
prevent its removal if an installed application is still using it.
No Progress Bar
To hide the progress bar, mark this for every file in the installation. If you mark
it for some files, but not others, the progress bar seems to display c ontinuously
because the screen does not refresh between files.
Self-Register OCX/DLL/EXE/TLB
All .OCXs and .TLBs and some .DLLs and .EXEs support self-registration. Mark
this so the file registers itself in the Windows registry before it is used.
Do Not Download With WebDeploy
This check box is available if you click Comple te support for Internet-bas ed
installation on the WebDeploy pag e. In an Intern et-based installation, f iles are
stored as separate files in the same directory as the installation .EXE on the
Web server and are downloaded only as they are needed.
Mark this check box to put the file in the installation .EXE rather than storing it
as a separate file.
Repair application if this file is missing
WiseScript Package Editor Reference53
Mark this to start self-repair if this file is missing when the application starts.
This prevents your application from failing if this file is accidently deleted.
Page 54
Creating WiseScript Installations
See Using Self-Repair on page 30.
Replace Existing File
Specify when to replace existing files on the destination computer.
Always
The new file always replaces the old file.
Never
The file never overwrites an existing file. Select this for files that should be
installed if they are not present, but which might be customized by the end
user and should therefore not be replaced on re-installation (example:
configuration files).
Check File
The existing file is only replaced if the requirements you set in File Version
and File Date/Time are true.
File Version, File Date/Time
These become enabled if Check File is selected from Replace Existing Files.
Doesn’t Matter
Select this option if only one of the requirements, File Version or File
Date/Time, must be fulfilled to replace the existing file.
Same or Older
For File Version, this replaces the existing file if it has a version resource
that is the same as or older than the new file. If the existing file lacks a
version resource, it is not replaced.
For File Da t e/T im e , this replaces the existing file if its modification date
and time are the same or older than the new file.
Older
For File Version, this replaces the existing file if it has a version resource
that is older than the new file. If the existing file lacks a version resource, it
is not replaced.
For File Da t e/T im e , this replaces the existing file if its modification date
and time are older than the new file.
Retain duplicates on path
By default, version checking removes existing copies of .DLLs that are found in
the path list. To suppress this feature, mark this check box.
Existing File Pathname
SmartPatch creates a patch file that contains only the differences between the
older installation and the new installation. If you are using Smartpatch, specify
the path where the installation can expect to find one of the files listed in
Previous File Versions. If a wildcard was used in Source Pathname, this
field should contain a directory. Start the path with a variable.
Previous File Versions
Use the Browse button to create a list of files that are older versions of the file
or files being installed.
Note
Rather than specifying SmartPatch information for each file, you can use the
SmartPatch page in Installation Expert to specify entire directories that contain
older versions of your files.
WiseScript Package Editor Reference54
Page 55
Fonts
Creating WiseScript Installations
See SmartPatch on page 74.
4. Click OK.
See also:
Adding Contents of Directories on page 52
Files on page 50
¾ WiseScript Package Editor only
Use the Fonts page to add fonts to an installation. You only need to add fonts when they
are required by the application being installed. Any fonts that were added on the Files
page are listed here.
Select Installation Expert > Fonts page, click Add at the right of the page, and complete
the Select Fonts dialog box:
zFrom Component, select the component in which to install the fonts.
zIn the left list box, select the directory containing the font.
zIn the right list box, select the font.
The font is added to the selected component.
General Information
Use the General Information page to set the summary informat ion for the compiled .EXE
file. End users can see the summary information by right-clicking the compiled .EXE in
Windows Explorer and selecting Properties.
If you plan to use an automated build system and want to set these values at compile
time, create compiler variables to set these values, and enter the compiler variable
name, surrounded by percent signs, in these fields. (Example: If you create a compiler
variable named _INST_VERSION_ to set the version, enter %_INST_VERSION_% in the
Installation Version field.)
See Compiler Variables on page 44.
(WiseScript Package Editor) Select Installation Expert > General Information page and
complete the page.
(WiseScript Editor) Select Project Settings > General Information and complete the
page.
zInstallation Version
The version number of the WiseScript.
zDescription
A description of the WiseScript, perhaps including your application’s name.
zCopyright
The copyright notice for the WiseScript.
WiseScript Package Editor Reference55
Page 56
INI Files
Creating WiseScript Installations
zCompany Name
¾ WiseScript Package Editor only
The INI Files page lets you create a new .INI file or update an .INI file on the destination
computer during installation.
1. Select Installation Expert > INI Files page.
2. Select the destination directory from the left list.
3. Click New File.
The Edit INI File Settings dialog box appears.
4. From File, select a default path where the .INI file is stored.
Example: %SYS32%\NONAME.INI.
5. Overwrite the default NONAME.INI with the appropriate name.
Example: System.ini.
6. In INI File Contents, enter the information that appears in the .INI file.
You can copy and paste the .INI contents from an existing file into this field. You
must enter at least one section heading and one command line.
If you create an .INI file to update a system file on the destination computer, your
settings are merged into the existing system file during the installation. Any
duplicate settings are overwritten with the values you enter here.
7. Click OK.
To remove an .INI file from the installation, select it in the list on the right and click
Delete. To edit an existing .INI file, select it in the list on the right and click Details.
See Editing INI File Settings.
Editing INI File Settings
¾ WiseScript Package Editor only
1. Select Installation Expert > INI Files page.
2. Select the file on the right of the INI Files page and click Details.
The Edit INI File Settings dialog box appears.
3. Complete the dialog box:
File
Displays the path to the .INI file. Installation Expert uses a variable (example:
%MAINDIR%) to refer to the directory . To edit this field, you must create a new
.INI file item.
INI File Contents
WiseScript Package Editor Reference56
Enter changes to make in the .INI file. Changes are interpreted as follows:
Page 57
To add to a section, type the section name in brackets, then type new lines
To delete a section and its contents, type a section name with no lines after
To delete a name-value pair, type the name with an equals sign followed by
Comments (lines starting with ;) are not supported.
Yo u can enter variables in INI File Contents to insert the values of script
4. Click OK.
See also:
Creating WiseScript Installations
for that section. If the .INI file already contains a name-value pair that you
type, the existing line is replaced by the new one. Example:
[SECTIONNAME]
Color=Blue
it. Example:
[SECTIONNAME]
nothing. Example:
Color=
variables into the .INI file.
See Variables and Expressions on page 110.
INI Files on page 56
Updating an Existing .INI File on the Destination Computer
Edit INI File on page 150
Updating an Existing .INI File on the Destination Computer
¾ WiseScript Package Editor only
You can make changes to one or more of the existing system files on the destination
system, such as the Win.INI and System.INI file.
1. Select Installation Expert > INI Files page.
2. Select the folder where the existing system file is located.
3. Click New File to open the Edit INI File Settings dialog box.
4. From File, select the path where the .INI file you want to update is stored.
For example, %SYS32%\NONAME.INI
5. Overwrite the NONAME.INI text with the name of the .INI file that you want to
update, such as System.ini.
6. In INI File Contents, enter the information that you want to add to the .INI file.
During the installation, your settings are merged into the existing system file.
Any duplicate settings are overwritten with the values you enter here.
7. Click OK.
See also:
INI Files on page 56
Editing INI File Settings on page 56
WiseScript Package Editor Reference57
Page 58
Installation Log
¾ WiseScript Package Editor only
Use the Installation Log page to create an installation log and to specify its location and
name. As an alternative, set the compiler variable _LOGFILE_PATH_ to the path of the
log file.
The installation log is a text file that lists the events that occur while the installation
runs. (Example: It contains the list of files that are replaced.) Entries are also added to
the log when files are deleted or backed up, but the uninstaller does not take such
entries into account during rollbacks.
Select Installation Expert > Installation Log page and complete the page:
zDo not create installation log
Mark this to prevent an installation log from being created. If you do this, the end
user will get an error upon trying to uninstall.
zCreate installation log in same directory as first installed file
This saves the installation log in the root, because the first Install File action is in the
uninstal.wse include script, which appears before any of your Install File lines. This
option is included for backward compatibility.
Creating WiseScript Installations
Languages
zCreate installation log in custom directory
Mark this to save the installation log in a directory you specify. This enables the
options for selecting the directory. Select a directory and enter a name for the
installation log in Install Log File Name. (Example: Install.log.) To create a new
directory for the log within the Application or Windows directory, click New Folder.
See also:
Add Text to INSTALL.LOG on page 120
Open/Close Install.log on page 181
¾ WiseScript Package Editor only
Use the Languages page to define the languages that are supported by the installation,
the default language, and the font used by the Japanese version of the installation.
For information on adding language support to an installation, see Language Support on
page 31.
To set language settings
Select Installation Expert > Languages page and complete the page:
zLanguages list
Mark the check box next to each language to translate this installation to. This list of
languages is presented to the end user at the start of the installation.
If the language you need is not listed, add it to the installation.
See To add a language to the installation on page 59.
WiseScript Package Editor Reference58
Page 59
Creating WiseScript Installations
Note
If you add support for a double-byte language, do not include any other languag es
in the installation. Including double-byte and single-byte languages in the same
installation can cause distortion of the fonts for the single-byte languages. If you
need both single and double-byte installations, make a copy of the installation and
include the double-byte languages in the copy.
zDefault Language
Select the default language for the installation.
zJapanese Font Name, Japanese Point Size
If you create a Japanese installation, enter the font and point size to be used.
zCopy Default
Mark this to copy messages from the default language to all others to provide a
starting point for translating the message.
Example: Your installation supports two languages and you add a Display Message
action to your script with English selected in the Scrip t Editor Language drop-down
list. If Copy Default is marked and you select French from the Language dropdown list, the text you entered in the English Display Message is copied to the
French version of the Display Message action.
zAlways Prompt
Mark this to have the installation always prompt the end user to select a language,
unless there is only one language in the installation.
To add a language to the installation
If the language you need is not listed on the Languages page:
1. Click Add on the Languages page.
The Select Languages dialog box appears, which lists the languages that are
available. This dialog box is populated with the pre-translated languages plus any
languages that you add on the Installer Messages dialog box. If the language you
need is not listed, add it to the installation.
See Editing Installation Messages on page 24.
2. Select the language and click OK.
The language you select is added to the list on the Languages page.
Clearing or Deleting a Language
When you mark a language check box, then clear it, the translation remains in the
installation but is not added to the compiled installation. This lets you omit a language
from the compile without losing any translated text strings. This is especially important
when you have added custom translated text.
To delete a language, select it from the list and click Delete. This removes the selected
language from the installation, however, it does not delete the language translations
that you entered on the Installer Messages dialog box.
WiseScript Package Editor Reference59
Page 60
Media
Creating WiseScript Installations
¾ WiseScript Package Editor only
Use the Media page to configure the installation for the type of media on which it will be
stored and distributed.
Select Installation Expert > Media page and complete the page:
zSingle File Installation
Mark this to pack all the files into a single installation file. This is useful for
distributing the installation over a LAN or the Internet. (In the latter case, consider
using WebDeploy technology to reduce the bandwidth required for the download.)
zMedia-Based Installation
Mark this to break the installation into files that fit on a specific type of removable
media and to enable the following fields:
Media Type
Select the type of media to use.
Custom Size
If you selected Custom in the Media Type fi eld, enter the formatted capacity of
the media you are using in this field.
Microsoft SMS
¾ WiseScript Package Editor only
If an installation runs in a Microsoft Systems Management Server (SMS) environment,
you can have the installation cre ate a status . MIF file and a definition file (.PDF or .SMS )
in the Windows directory during compile. Use the Microsoft SMS page to specify the
information for the .MIF file and package definition file. For information about SMS, see
msdn.microsoft.com.
Note
You can use the Exit Installation script action to write text and a success/failure flag to
the status MIF file.
See Exit Installation on page 162.
Select Installation Expert > Microsoft SMS page and complete the page:
zInstall MIF Filename
zUninstall MIF Filename
zManufacturer, Product, Version
Enter the name of the application being installed. Example: sample.mif.
Enter the name of the application being uninstalled. Example: uninstall_sample.mif.
These fields are required. If they are left blank, the package definition file is not
created.
zSerial Number
Enter the serial number of the application being installed.
WiseScript Package Editor Reference60
Page 61
ODBC
Creating WiseScript Installations
zPackage Definition File
T o creat e a package definition file when the instal lation is compiled, mark one of the
following and enter the correct SMS version:
Create Package Definition File (SMS 1.2 or earlier)
Mark this to create a package definition file of file type .PDF.
Create SMS File (SMS 2.0 or later)
Mark this to create a package definition file of file type .SMS.
T o distribute the package definition file with the installation using Package Distribution in
Workbench, select Network and the Compiled package option on the Distribution
Method page. If you distribute the installation to the share point directory and import it
into Software Manager, the installation and the SMS package definition file are copied to
the share point Available Packages directory when you change its status to Available.
¾ WiseScript Package Editor only
Use the ODBC page to add ODBC data sources that are required by the application on
the destination computer. To add ODBC driver support, select MDAC on the Runtimes
page.
Select Installation Expert > ODBC page, click Add at the right of the page, and complete
the Configure ODBC Data Source dialog box:
zData Source Name
This name will be displayed in the ODBC data sources list on the destination
computer. The Import button adds an ODBC data source from your computer and
populates the fields.
zDriver Name
Enter the name of the ODBC driver used by this data source. The driver, along with
its support files, must already have been installed on the destination computer.
zInstall Data Source for
Select Win16 or Win32 APIs.
zData Source Attributes
Either enter attributes, or use the Imp ort button to import them from an ODBC data
source installed on your computer.
zDisplay Configuration Dialogs
Mark this to display standard data source configuration dialog boxes to the end user.
Otherwise, the data source is configured with default settings.
zSystem DSN
Mark this to make the data source available to all user accounts on the destination
computer.
See also:
Config ODBC Data Source on page 136
WiseScript Package Editor Reference61
Page 62
Online Registration
¾ WiseScript Package Editor only
Use the Online Registration page to configure the online registration feature. This lets
the end user register the program after the installation has been completed successfully.
Product registration is supported through a CGI program or Active Server Page that
accepts the data through the HTTP POST operation.
Select Installation Expert > Online Registration page and complete the page:
zNo Online Registration
Mark this if you do not support online registration.
zOnline Registration
Mark this if you support online registration. The following fields become enabled:
Post to URL
Enter the URL of the CGI program or Active Server P age that accepts the data
through the HTTP POST operation. Registration is passed to the Web server in
the named fields NAME, COMPANY, ADDRESS1, ADDRESS2, ADDRESS3, EMAIL,
WEBADDRESS, PURCHASEDATE, SERIALNO, PHONE, PRODINFO, CITY, STATE,
and ZIP.
Creating WiseScript Installations
Password
Registration INI File Name
In the directory structure of the installation that is displayed above this field,
specify the location of the file that will contain the registration data on the
destination computer. Use the New Folder button to create a new directory
within the Application or Windows directory.
Enter a name for the file that will contain the registration data. Future
installations use this file to pre-enter the user’s registration details, such as
name and company. The end user can still change the fields before registering.
¾ WiseScript Package Editor only
Use the Password page to specify a required password or serial number for an
installation. End users must enter the correct password or serial number to begin the
installation.
Select Installation Expert > Password page and complete the page:
zSingle password used for all installations
Mark this to require a single password for any copy of the installation. In the field to
the right of this option, enter the password.
zIndividual serial numbers used as password
Mark this to have the installation work with a range of serial numbers and to enable
the following fields. This does not produce multiple serialized copies of the
installation but a single installation that accepts any of the generated serial
numbers.
Serial Number Type
WiseScript Package Editor Reference62
Choose whether to create incremental serial numbers (in sequence) or
randomly generated serial numbers.
Page 63
Starting Serial Number, Ending Serial Number
Approx. Serial Numbers
Output File
For maximum protection, use a random serial number scheme and a serial number
range that exceeds the number of copies you will produce by a factor of 100 or
more. Example: If you generate 1,000 random serial numbers between 1,000,000
and 9,999,999, unauthorized users have only a one-in-9,000 chance of correctly
guessing a serial number.
You can turn password protection on and off on a per-file basis by selecting a file on the
Files page and clicking Details.
See Require Password in Specifying Installation File Settings on page 53.
Product Details
Creating WiseScript Installations
Define the range of serial numbers by entering a starting and ending number.
Enter the approxima te quantity of serial n umbers.
Specify a text file name, then click Export. This writes the serial numbers to the
specified file. You can use this file to print labels to serialize your application.
Progress Bar
¾ WiseScript Package Editor only
Use the Product Details page to specify the title and the default directory for the
installation.
Select Installation Expert > Product Details page and complete the page:
zInstallation Title
Enter the name of the application. It appears on the background screen and on the
dialog boxes during the installation.
zDefault Directory
Enter the name of the directory in which your application is installed by default. The
end user can override this default.
zPlace default directory under Program Files
Mark this to place the default direc tory in the Program Files directory instead of in
the hard disk’s root directory. The end user can change the location.
¾ WiseScript Package Editor only
Use the Progress Bar page to set options for the progress bar that displays while the
installation is running. The default progress bar uses a .DLL that is in the WiseScript
Editor\Progress subdirectory of this product’s installation directory. The source code for
this .DLL is in the WiseScript Editor\Dll\Progress directory. You also can use an external
.DLL for displaying the progress bar.
Select Installation Expert > Progress Bar page and complete the page:
zProgress Dialog Placement
Select a screen position for the progress bar.
WiseScript Package Editor Reference63
Page 64
Creating WiseScript Installations
zProgress Bar Based On
Select how progress should be calculated.
zCustom Progress Bar .DLL
By default, this path points to an operating system-specific .DLL that displays a
custom progress bar. If you have a custom .DLL that displays a progress bar, specify
its path here. If you delete this path, the progress bar defaults to a smaller, more
generic progress bar.
zCenter All Dialogs Over Progress Dialog
Mark this to center all dialog boxes in front of the progress bar, effectively hiding it
whenever end user input is required.
zDo Not Allow Installation to Be Can c ell e d
Mark this to disable the Cancel button on all dialog boxes that appear to the end
user during installation. Use this option for administrative installations.
zDo Not Allow Progress Dialog to Be Cancelled
Mark this to disable the Cancel button on the Progress dialog box that appears on
the destination computer. Use this option for administrative installations.
In the Initialization Splash Screen section, you can modify the first splash screen that
appears when the end user runs the installation or uninstall.
zInitialization splash screen
Choose Custom to modify the splash screen .
Registry
zInitialization .BMP File
This is enabled when you select Custom from Initialization splash screen.
Specify the .BMP file for the splash screen that end users first see when they run the
installation.
Note
If the bitmap file you select for your custom splash screen doesn’t appear correctly,
you probably haven’t selected a valid .BMP file. Non-valid bitmap fil es do not appear,
and no error message is displayed to inform you of the problem.
¾ WiseScript Package Editor only
Use the Registry page to specify the registry entries to be installed or edited on the
destination computer. You can either add registry entries manually or import a registry
file (.REG).
The left two list boxes display key structure, and the right two list boxes display values.
The upper two list boxes display your computer’s registry. The lower two list boxes
represent the keys and values to be installed on the destination computer.
Working With the Registry Page
Use the following buttons:
zAdd Keys
Copy a registry key, including all its subkeys and values, from your computer to the
installation.
WiseScript Package Editor Reference64
Page 65
zAdd Values
Copy values from your computer to the installation.
zNew
Create a new key or import a registry file into the installation. The presence of a key
in this list does not necessarily mean that the key is added to the registry on the
destination computer. It merely indicates that the installation operates on the key in
some way. The operation might be to add a new key or named value, to modify an
existing named value, or to delete a value.
zDelete Key, Delete Value
Remove a registry key or v alue from the installation. Thi s does not delete the key or
value on the destination computer.
zDetails
Edit registry key settings.
See also:
Configuring Registry Key Settings on page 66
Creating or Editing Registry Key Settings on page 65
Creating or Editing Registry Key Settings
Creating WiseScript Installations
¾ WiseScript Package Editor only
On the Registry page in Installation Expert, you can add new registry k eys, edit e xisting
registry values, and import registry files.
To add an empty registry key
1. Select Installation Expert > Registry page.
2. In the lower-left list box, select the location for the key.
3. Click New and select Key.
The Registry Key Settings dialog box appears.
4. From Operation, select Create empty key.
5. In Key, click at th e e nd of the existing text, and add a backslash and the name of
the new key.
Example: Append \Preferences to the end of the existing key name.
6. Click OK.
To add a registry value
1. Select Installation Expert > Registry page.
2. In the lower-left list box, select the key to contain the value you’re adding.
3. Click New and select Key.
The Registry Key Settings dialog box appears.
4. Complete the dialog box and click OK.
See Configuring Registry Key Settings.
WiseScript Package Editor Reference65
Page 66
The registry value is added and appears in the lower-right list box. To edit it, doubleclick its name. To delete it, use the right-click menu.
To import a registry file
1. Select Installation Expert > Registry page.
2. Click New and select Import.
3. On the Select Registry File to import dialog box, specify the registry file (.REG file).
See also:
Registry on page 64
Configuring Registry Key Settings
¾ WiseScript Package Editor only
Use the Registry Key Settings dialog box to set or edit registry key settings.
1. Select Installation Expert > Registry page.
2. Do one of the following:
Creating WiseScript Installations
Click New > Key.
Double-click a registry value in the lower-right list box.
The Registry Key Settings dialog box appears.
3. Complete the dialog box:
Operation
Select the operation to apply to the key or its associated value.
Create/update key and value
The value is updated if it already exists. If the key or v alue does not exist, it
is created.
Create empty key
Creates the key but does not add any values.
Remove key and all subkeys
Deletes the key, its subkeys, and all named values associated with the key
and its subkeys on the destination computer.
Remove key and value only
Removes the named value from the key on the destination computer. If the
key has other named values, they are preserved.
Preserve existing key and value
Adds a new key or value if the specified item does not exist, but leaves the
existing value in place if one already exists.
Root
Select the parent key in which the new key is added.
Key
WiseScript Package Editor Reference66
Enter the name of the new key. You can create multiple hierarchical keys at
once by separating them with backslashes, as in directory paths. (Example:
Entering Protocol\StdFileEditing creates the StdFileEditing key inside the
Protocol key.) Any keys in the path that do not exist are automatically created.
Page 67
Creating WiseScript Installations
Value Name
Enter the name of a new named value.
Data Value
Enter the data for the value. To insert multiple lines of data here, press
Ctrl+Enter to begin a new line.
If the Data Type (below) is Double word (DWORD), enter the data in decimal
notation.
Data Type
Select the type of data contained in the named value.
The associated Windows API data types are in parentheses below.
String
(REG_SZ) Identifies the value as an expandable string. To include a
Windows system variable, enclose it in double percent signs. For example,
%%WIN%%.
Unexpanded string
(REG_EXPAND_SZ) Identifies the value as a string that contains unexpanded
references to environment variables that are expanded when the value is
retrieved. Enclose the environment variables in single percent signs. For
example, %PATH%.
If you do not want the variable to be expanded, enclose it in double percent
signs. For example, %%WIN%%. This allows Windows system variables to
be embedded.
Multiple strings
(REG_MULTI_SZ) Identifies the value as a series of null-terminated strings.
Type the value as multiple pieces of text and press Ctrl+Enter after each
one.
Double word
(REG_DWORD) Identifies the value as a 32-bit number in decimal notation.
Binary/Hex
(REG_BINARY) Identifies the value as a binary in hexadecimal notation.
Separate each byte by at least one space, like the following example:
AD 30 C0 A9 40 20 A8 FC 4C 00 08
None
This option is provided for compatibility with SMS Installer installations. It
behaves the same as the binary data type.
Repair application if this registry value is missing
Self-repair prevents an application from failing if this registry value has
accidentally been deleted. Mark this check box to start self -repair if this registry
value is missing when the application starts. The end user must have access to
the installation media to perform a repair, and you must also configure a
shortcut to the application with self-repair turned on.
Append Data
WiseScript Package Editor Reference67
See Using Self-Repair on page 30.
Normally , if you set a registry key to a new value and the key already exists , the
value is replaced with the new value. If you want to append the new data to an
existing multiple strings value instead of replacing it, mark this check box. This
Page 68
Runtimes
Creating WiseScript Installations
option is unavailable unless Multiple Strings is selected in the Data Type
drop-down list.
4. Click OK.
See also:
Creating or Editing Registry Key Settings on page 65
Registry on page 64
Edit Registry on page 151
¾ WiseScript Package Editor only
Use the Runtimes page to select various runtimes to include with the installation.
Runtimes are sometimes pre-selected after running the Import Visual Basic Project tool
or ApplicationWatch. To add ODBC data sources, use the ODBC page. See ODBC on
page 61.
Warning
Installing the wrong version of runtime support files can cause the end user's
applications to stop running properly and can even disable the operating system. Before
deploying any installation that installs runtimes, select Help menu > Download Runtimes
to get the latest runtime updates.
To add a runtime
1. Select Installation Expert > Runtimes page.
2. Mark the check box of the runtime to add.
For many runtimes, a dialog box then appears where you can specify the version of
the runtime or other settings. You can edit these runtime settings by selecting the
runtime and clicking Details. If no dialog box appears when you mark a runtime,
then that runtime has no settings to edit.
A description section at the bottom of the Runtimes page provides information on the
currently-selected runtime.
Microsoft Data Access Components
The MDAC section of the Runtimes page lists the different versions of Microsoft Data
Access Components (MDAC) that are available to distribute with your application.
Database Runtime
The Database Runtime section of the Runtimes page lists connectivity runtimes. If your
application requires any database connectivity, you probably need to include one of
these options in the installation.
Visual Studio Support
The Visual Studio Support section of the Runtimes page lists Visual Basic, Visual F o xPro,
and Visual C++ runtimes. If the application you’re deploying was developed using one of
these development languages, you might need to have the appropriate runtime preinstalled to ensure a complete and error-free installation.
WiseScript Package Editor Reference68
Page 69
Creating WiseScript Installations
Windows Runtime
The Windows Runtime section of the Runtimes page lists common Windows runtimes.
Add these runtimes when the runtime is critical to the application you are deplo ying, and
when you expect that the end users do not have the runtim e installed.
Crystal Reports Runtime
The Crystal Reports Runtime section of the Runtimes page lists Crystal Reports™
runtimes.
Note
To include Crystal Reports runtimes in your application, you must have Crystal Reports
installed on your local computer.
Software Virtualization Solution
The Software Virtualization Solution section of the Runtimes page lists the SVS Driver
runtime. When you distribute a virtual runtime archive file (.VRA), use this runtime to
ensure that the target computer has the SVS Driver runtime installed before installing
the .VRA file. A .VRA file cannot be installed if the SVS Driver runtime or a compatible
driver is installed.
Screen
When you include the SVS Driver runtime, you must define the compiler variable
_SVSDRIVERINC_ on the Compiler V ariables page. Y ou can assign the v ariable a value of
1 or 0. If you assign it a value of 1, the SVS Driver is included with the installation. If
you assign it a value of 0, the driver is downloaded during installation and the s ize of the
installation is reduced significantly.
See Compiler Variables on page 44.
The SVS Driver runtime requires a reboot of the end user’s computer after it is installed.
Design your WiseScript so that it resumes properly after the reboot. For a good example
of how to handle a reboot when installing the SVS Driver, see the VsaWrapper.wse
WiseScript that is in the Virtual Package Editor\Templates directory.
The SVS Driver runtime does not appear in Add/Remove Programs on the end user’s
computer. The end user can remove the SVS Driver runtime by using the following
command line: Msiexec.exe /x {7D8DBB7C-1C55-4950-A107-043C164F379A}.
Warning
If the end user removes the SVS Driver runtime, any application that is inst alled into an
SVS layer becomes non-functional.
You can download the latest SVS Driver runtime from the Help menu.
See Downloading Application Runtimes on page 26.
¾ WiseScript Package Editor only
Use the Screen page to set the background pattern and font for the installation.
Select installation Expert > Screen page and complete the page:
WiseScript Package Editor Reference69
Page 70
Creating WiseScript Installations
zBackground Gradient
Select the background gradient.
zTitle Bar
Mark this to cause the installation’s title to be displa yed at the top of the screen in a
title bar.
zHide Program Manager
Mark this to hide the Program Manager during installation (Windows 3.x only).
zNo Background Gradient
Mark this to display no gradient behind the installation dialog boxes.
zTop Color, Bottom Color
Click these buttons to choose the top and bottom colors for the background
gradient. The installation generates a smooth transition between the two colors.
zScreen Preview
Displays a real-time mock-up of how the installation screen will look.
zBold/Light Fonts
Select the font option.
zMessage Box Font
Specify the font to be used. If you do not specify a font, a standard sans serif font is
used. For a Japanese installation, specify MS Gothic.
Services
zPoint Size
Specify the point size for text displayed on the installation dialog boxes. If you do
not specify a point size, the standard Windows text size is used.
zCharacter Set
Enter the number of the character set to be used. Use zero, which is the default,
unless the installation is in Japanese. For a Japanese installation, enter 128 and
make sure you have specified MS Gothic in the Message Box Font field.
¾ WiseScript Package Editor only
The Services page lets you define applications to be installed as a Windows NT service.
The .EXE file you define as a service must already be a part of the installation. Consult
Microsoft developer documentation for information on creating services. This page only
helps you install services, not develop them.
To add a new service item
1. Select Installation Expert > Files page.
2. Add the .EXE file that runs the service.
3. Select the Services page.
4. Click Add at the bottom of the page.
The Select File from Installation dialog box opens, which displays directories and
.EXE files from this installation.
5. Navigate to and select the .EXE.
6. Click OK.
WiseScript Package Editor Reference70
Page 71
The service appears in the list on the Services page.
To change the .EXE file for a service, select it from the list and click Details.
See Configuring Service Settings.
To remove an existing service from the installation, select it from the list and click
Delete.
If you chose an .EXE file that is part of an optional installation component, the service is
installed only if that component is installed.
See also:
Create Service on page 140
Configuring Service Settings
¾ WiseScript Package Editor only
1. Select Installation Expert > Services page.
2. Select a service and click Details.
The Create Service Settings dialog box appears. It lets you control the behavior of
the service when it is run. Refer to Microsoft developer documentation for
information about creating services.
Creating WiseScript Installations
3. Complete the dialog box:
Service Name
Enter the internal service name, which is used in the registry.
Display Name
Enter the name to appear in the Services control panel.
Executable Path
Specify the complete path to the executable file as it will be on the destination
computer. Start the path with a variable (example: %MAINDIR%).
Login Username, Password
Enter the user name and password under which the service should run.
Error Control
Specify what happens if an error occurs while the service starts.
Ignore Error
Logs the error and continues.
Normal Error
Displays a message to the end user, logs the error, and continues.
Severe Error
Logs the error. If the computer is starting the last known good configur ation,
startup continues. Otherwise, it restarts with the last known good
configuration.
Critical Error
Logs the error if possible. If the computer is starting the last known good
configuration, startup fails. Otherwise, it restarts with the last known good
configuration.
WiseScript Package Editor Reference71
Page 72
Group
Enter the name of the load ordering group to which this service belongs. Leave
this empty if the service does not belong to a group.
Dependencies
Enter a list of semicolon-separated names of services or load ordering groups
that must start before this service. Leave this empty if there are no
dependencies. If a service is dependent on a group, at least one member of the
group must be started for this service to run.
Enter a plus sign (+) before group names to distinguish them from service
names. Services and service groups share the same name space. Example: If
you enter this string, "ftpsvr;httpsvr;drc;+sample", you create dependencies on
the ftpsvr, httpsvr, and drc services and the sample group.
Service Type
Select a service type.
Start Service
Select the default setting for starting the service.
Service Interacts With Desktop
Mark this to let the service display its user interface.
4. Click OK.
Creating WiseScript Installations
Shortcuts
See also:
Services on page 70
¾ WiseScript Package Editor only
Use the Shortcuts page to add shortcuts to the Startup Group, desktop, or Start menu of
the destination computer.
If you added program files on the Files page, Installation Expert might have added the
default application shortcuts. The Shortcuts page shows shortcuts that have been added
so far.
To add a shortcut to an installation
1. Select Installation Expert > Shortcuts page.
2. In Default Folder Name, enter the default folder name for Start menu shortcuts.
The end user can change this during installation. You must specify a folder name
before you can add any shortcuts.
3. Click Add.
The Select File from Installation dialog box opens.
4. Navigate to and select a file to create a shortcut for.
5. Click OK.
The Shortcut Details dialog box appears.
6. Complete the dialog box and click OK.
WiseScript Package Editor Reference72
Page 73
See Editing Shortcut Details on page 73.
The new shortcut appears on the Shortcuts page.
To edit an existing shortcut, select it and click Details. To remove a shortcut from the
installation, select it and click Delete.
If you create a shortcut to a file that is in an optional component of the installation, the
shortcut is created only if that component is installed.
See also:
Create Shortcut on page 142
Editing Shortcut Details
¾ WiseScript Package Editor only
1. Select Installation Expert > Shortcuts page.
2. Select the shortcut and click Details.
The Shortcut Details dialog box appears.
To customize a shortcut further or to place it in a subfolder in the Start menu, go to
Script Editor and double-click the Create Shortcut line within the If System Has
Windows 95 Shell Interface statement.
Creating WiseScript Installations
3. Complete the dialog box:
Shortcut Name
Enter the name of the shortcut.
Command Line Options
Enter the command-line options that are used to open the file associated with
the new shortcut.
Icon Pathname
(Optional) Specify the file that contains the icon to be used for the shortcut.
Otherwise, the target file’s icon is used.
Icon Number
Enter the number of the icon to use from the file specified in Icon Pathname
above.
Default Directory
Enter the default directory that should be set when running the target file, if
different from the target file’s location. In Windows Explorer, this field is
referred to as the Start in directory.
Shortcut Pathname
Displays the path of the file that is opened by the shortcut.
Shortcut Location
Select where to place the shortcut.
Enable Access For All Windows NT Users
For Windows NT, mark this to give all users access to the shortcut. This only
works if the user logged in during installation has administrator privileges.
WiseScript Package Editor Reference73
Page 74
SmartPatch
Creating WiseScript Installations
Check self-repair items when this shortcut is opened
Mark this to turn on self-repair functionality for this shortcut if you have
configured the installation for self-repair. Typically, use this for a shortcut that
starts the application.
See Using Self-Repair on page 30.
4. Click OK.
See also:
Shortcuts on page 72
¾ WiseScript Package Editor only
Use the SmartPatch™ page to turn an installation into an upgrade (patch), instead of a
full version installation. When you distribute installations of this type, the destination
computer must contain a previous version of the application for the installation to be
successful.
To create a smart patch, make sure your computer contains a copy of the old software
that is being upgraded. After you specify the path to the old software, the SmartPatch
feature compares the older versions of the application to the version being installed and
generates a patch installation that contains only the differences between the two
versions. This can result in a significantly smaller installati on file. If y ou specif y multiple
previous versions, they’re upgraded no matter what version is on the destination
computer.
Select Installation Expert > SmartPatch page and complete the page:
zDo Not Create SmartPatch Updates
Mark this to create a full installation and not use the SmartPatch feature. You can
also leave this feature off while testing an installation, to produce faster compiles.
zCreate SmartPatch Updates
Mark this to enable SmartPatch and the following fields:
Error Checking
By default, SmartPatch expects the same file names to exist in both the old and
new copies of the software and displays errors when they don’t match. You can
change the default level of error checking.
Do not display errors
Select this option if you expect a significantly different file set in the new
installation.
Display error if all matching files not found
Select this option to prevent errors such as sp ecif ying an empt y or incorr ect
directory for the old software.
Patch Threshold
WiseScript Package Editor Reference74
Display error if any matching files not found
Select this option if the old and new installations should have all the same
file names, but different versions.
Determines at what point SmartPatch simply includes the entire new file rather
than creating a patch. The default is 85%, meaning that when the patch file (for
Page 75
Creating WiseScript Installations
all versions to be updated by SmartPatch) is at least 85% of the size of the
complete file, the complete file is included rather than the patch. However, even
though the entire file is included in the installation, it is not installed unless the
end user has a valid copy of an older version of the file.
Maximum Memory
Determines how much memory the SmartPatch feature can use. SmartPatch is
very memory-intensive. Set this value to 2 MB less than the amount of RAM
installed in your computer.
Maximum Patch Compression
Mark this to compress patch files as much as possible. This tak es extr a time, so
leave this unmarked during development and testing, and mark it only when
creating your final distribution build.
Directory
This list displays directories on your computer that contain old versions of your
application that end users might have installed on their computers. SmartP atch
creates a patch file that updates any of these older versions to the most recent
version. The directory structures of each version must match exactly—only the
top-level directory name can be different.
To add a path to an old version of the software, click Add and specify the
directory.
To remove a path from this list, select it and click Delete.
System Requirements
¾ WiseScript Package Editor only
Use the System Requirements page to specify minimum hardware and software
requirements for the installation and to set warning messages that display to the end
user if the destination computer does not meet the requirements.
To set a system requirement
This procedure applies to any system requirement that you set on the System
Requirements page. Notes on specific system requirements follow the procedure.
1. Select Installation Expert > System Requirements page.
2. Double-click a requirement.
The Minimum System Requirements dialog box appears.
3. From the drop-down list at the top of the dialog box, 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 XP lets
an installation run on any computer with Windows XP or later operating system.
4. From Type, select an option:
Recommended
WiseScript Package Editor Reference75
Select this if this configuration item is not required by the program. The
message you enter in the Message Text field appears on the destination
computer if it does not meet the specified requirement, and the installation
continues once the message is acknowledged.
Page 76
Creating WiseScript Installations
Required
Select this if this configuration item is critic al to the installation and the progr am
cannot run without it. The message you enter in the Message Text field
appears on the destination computer if it does not meet the specified
requirement, and the installation is aborted.
5. When you specify a requirement, the Display Messages fields are enabled.
Message Title
Enter a name to appear in the title bar of the error message.
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.
6. 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
Windows 2000
Windows XP
Windows Server 2003
Windows Vista
Windows Server 2008
Windows 7
Windows Server 2008 R2
If the destination computer is running Windows 95/98/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.
Sound Support
The audio support options that are required.
WiseScript Package Editor Reference76
Page 77
System Search
¾ WiseScript Package Editor only
The System Search page specifies methods by which the installation can search for and
detect a previous version of the application. If you know certain files, registry valu es, or
.INI file changes that would be present if the application was installed previously, you
can use this page to search for a previous version of the application. If a previous
version is installed, its directory becomes the default directory for installation of the new
software.
System Search Usage
zIf you know of a specific file that exists only in the installation directory, you can
zIf, during the previous installation, you wrote the installation directory path into an
Creating WiseScript Installations
search for that file, and get its directory . In either case, the path you find is put into
the va riable %MAINDIR%. The variabl e %MAINDIR% represents the default
installation directory of the installation.
.INI file or into the registry, you can search for that path using this page. If you
know the path ends with a file name, mark Remove File Name when configuring
the registry or .INI search.
If you search for an .INI value, make sure the .INI Item Name contains a valid
path. If the search finds the .INI Item Name, its value is put into %MAINDIR%.
If you search for a registry value, make sure the registry value contains a valid
directory or path. If the search finds the registry Value Name, its Value Data is
put into %MAINDIR%.
The items listed on the System Search page display the search methods for finding the
old version of the application. The installation performs the searches in the order listed
until one is successful. It then makes the directory of the previous installation the
default directory for the installation. If none are successful, the directory you enter in
Default Directory on the Product Details page is the default directory.
To rearrange the order of items on the System Search page, click the Move Up or Move
Down buttons.
See:
Searching for Files or Directories on page 77
Searching for INI Values on page 78
Searching for Registry Values on page 79
Searching for Files or Directories
¾ WiseScript Package Editor only
On the System Search page, you can set up a search for a file or directory on the
destination computer. To find a directory, you must search for a specific file contained
inside the directory. When you search for a file, Windows Installer stops searching as
soon as it finds the first file or directory that matches your specification. Therefore, it’s
important that you specify unique file or directory attributes for your search. You can
specify to return either the full file path or just the directory that contains the file.
1. Select Installation Expert > System Search page.
WiseScript Package Editor Reference77
Page 78
Creating WiseScript Installations
2. Click Add at the right of the page and select Search for File.
The Search for File dialog box appears.
3. Complete the dialog box:
File Name
Enter the name of the file.
Description
Enter the message to display on the progress dialog box while searching.
Drives to Search
Select local hard drives only, network drives only, or both.
Search Depth
Set the search depth to zero to search the entire directory tree of the specified
volumes. A search depth of 2 or 3 is recommended when searching network
volumes.
4. Click OK.
To edit an entry, double-click its name. To rearrange the entry in the list, click the Move
Up and Move Down buttons.
See also:
System Search on page 77
Searching for INI Values
¾ WiseScript Package Editor only
On the System Search page, you can set up a search for a value in an .INI file on the
destination computer. Use this only to get an .INI value that you know to be a val id path
on the destination computer.
.INI File Terminology
zAn .INI file consists of sections with the following syntax:
zIn the section above, DirectoriesAndFiles is an INI Section Name and SrcDir is an
INI Item Name.
zItem Field refers to the number of the item in a comma-delimited list. Example:
The Item Field for E:\Sample\sample.dll in the section above is 2 because it is the
second item in the list.
To add an .INI file to the search list
1. Select Installation Expert > System Search page.
2. Click Add at the right of the page and select Read INI Value.
The Read INI Value dialog box appears.
3. Complete the dialog box:
WiseScript Package Editor Reference78
Page 79
Select the directory that contains the .INI file from the directory tree. If the
directory is not displayed, select its parent directory and click New F older to add
it.
INI File Name, INI Section Name, INI Item Name
Enter the file name of the .INI file to be read, the section that contains the entry
to be read (without the square brackets), and the item name of the entry.
Remove File Name
Mark this to return only the directory name if it ends with a file name.
4. Click OK.
To edit an entry, double-click its name. To rearrange the entry in the list, click the Move
Up and Move Down buttons.
See also:
System Search on page 77
Searching for Registry Values
¾ WiseScript Package Editor only
Creating WiseScript Installations
On the System Search page, you can set up a search for a registry value on the
destination computer. Use this only to get an .INI value that you know to be a val id path
on the destination computer.
1. Select Installation Expert > System Search page.
2. Click Add at the right of the page and select Read Registry Value.
The Read Registry Value dialog box appears.
3. Complete the dialog box:
Root
Choose the root key that contains the named value to be read.
Key, Value Name
Enter the name of the key and the value to be read from that key.
Remove File Name
Mark this to return only the directory name if it ends with a file name.
4. Click OK.
To edit an entry, double-click its name. To rearrange the entry in the list, click the Move
Up and Move Down buttons.
See also:
System Search on page 77
WiseScript Package Editor Reference79
Page 80
Uninstall
Creating WiseScript Installations
¾ WiseScript Package Editor only
Use the Uninstall page to specify whether the installation supports the uninstall
capability and to set options for controlling which files are removed by the uninstall
program. The uninstall program is named unwise.exe.
Note
Installations contain the Repair option when you choose the application name in the
Add/Remove Control Panel. Choosing Repair re-ed its the registry and .INI files, reinstalls all files, and re-self-registers files.
Select Installation Expert > Uninstall page and complete the page.
zDo not add support for uninstall
Mark this to not give end users the ability to uninstall the application.
zSupport uninstall
Mark this to allow uninstall and to enable the following uninstall options.
Display uninstaller background window
Mark this to display a gradient window similar to the one displayed during
installation.
Top Color, Bottom Color
Click these buttons to choose the top and bottom colors for the background
gradient. The uninstall generates a smooth transition between the two colors.
Uninstaller Font
Specify the font to be used. If you do not specify a font, a standard sans serif
font is used. For a Japanese installation, specify MS Gothic.
Point Size
Select the point size for text displayed on the installation dialog boxes. If you do
not specify a point size, the standard Windows text size is used.
Character Set
Enter the number of the character set to be used. Use zero, which is the default,
unless the uninstall is in Japanese. For a Japanese uninstall, enter 128 and
make sure you have specified MS Gothic in the Uninstaller Font field.
The uninstaller reads commands from the Install.log file created during installation. On
the Uninstall page, you can add additional commands for the uninstaller.
See Adding Additional Commands for the Uninstaller.
Adding Additional Commands for the Uninstaller
¾ WiseScript Package Editor only
It is not necessary to add commands to delete files or registry entries that the
installation created.
1. Select Installation Expert > Uninstall page.
2. Click Add and select the type of command to enter.
3. If you select Delete File(s), the Delete File(s) dialog box appears.
WiseScript Package Editor Reference80
Page 81
Creating WiseScript Installations
Use this command to delete additional files, such as those created by your program
on first run.
Select the directory containing the files to be deleted. If the directory is not
displayed, select its parent directory and click New Folder to add it.
Enter the file name in Filename. You can use a wildcard to specify the files.
Click OK.
4. If you select Delete Registry Keys, complete the Remove Registry Tree dialog box:
Use this command to delete registry entries, such as those created during the
execution of your program.
Select the registry keys to be deleted. If the key is not displayed, select the k ey
it should be added to and click New Key to add it.
Click OK.
5. If you select Execute Program, complete the Select Program to Execute dialog box.
Navigate to and select the program to be executed (or enter its name in File
name). For best results, make sure that the program you execute has little or
no user interface. The uninstall procedure should seem like a single program to
the end user, even if additional programs are executed.
WebDeploy
Click OK.
6. On the Uninstall page, mark Delete in-use files during uninstall to delete even
those files that are in use when the uninstall program is running.
See also:
Uninstall on page 80
¾ WiseScript Package Editor only
The WebDeploy page provides an efficient method for creating true Internet-based
installations for your application. It creates a small stub installation that downloads the
compressed files from a Web server as needed.
When you compile a WebDeploy installation, stub files and data files are created. The
stub files are designed to be distributed over the Internet, that is, they contain all the
server connection information. When an end user clicks the stub file, WebDeploy
connects to the appropriate Web site, checks the system on the destination computer to
determine what it needs, then starts downloading files. After it has finished downloading
the files, it starts the installation.
Note
WebDeploy supports only basic authentication. In your Web server software, verify that
the directory you use for WebDeploy is secured with basic, not domain, authentication.
Also, if you use the FTP protocol for WebDeploy, note that WebDeploy does not support
passive transfers through FTP. Some firewalls and gateways require passive FTP
transfers.
WiseScript Package Editor Reference81
Page 82
See:
The WebDeploy Process on page 82
Creating a WebDeploy Installation on page 82
Uploading a WebDeploy Installation to the Web on page 84
The WebDeploy Process
Creating WiseScript Installations
Phase 1:
Phase 2:
Phase 3:
Your Computer
Upload files through FTP
When you develop the installation, you:
z Configure WebDeploy by specifying the location of
installation files on the Web server
z Compile the installation
z Upload the installation files to the Web server
z Notify end users of the Web link to the .EXE
Destination Computer
(HTTP Protocol)
The end user:
z Runs the installation .EXE from your Web server
Destination Computer
(HTTP Protocol)
Your Internet Host (FTP/HTTP) Server
z Contains the installation
The installation is copied to the host
but is not used yet
The installation and its pieces are
stored in an .EXE file plus files named
.001, .002, and so on
Your Internet Host (FTP/HTTP) Server
z Contains the installation .EXE and other
files
Your Internet Host (FTP/HTTP) Server
z Contains the pieces of an installation
ready for download
z Contains the new installation and its
ReadMe
When the end user runs the .EXE, it:
z Runs an installation wizard
z Determines which pieces of the application are needed
z Downloads and installs the appropriate pieces of the application
See also:
WebDeploy on page 81
Creating a WebDeploy Installation
The WebDeploy™ page lets you enable an installation for distribution through 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.
WiseScript Package Editor Reference82
Page 83
Creating WiseScript Installations
Note
Installations that are deployed through WebDeploy contain a Repair option in the
uninstall wizard, but the Repair option does not function.
To create a WebDeploy installation
1. Select Installation Expert > WebDeploy page.
2. Select one of the following:
Add support for Internet-based Copy Local Files script action
Mark this if you add a Copy Local Files script action that will download or upload
to a Web site. If you mark this option, select the protocol for the Copy Local
Files action from File Transfer Via.
Complete support for Internet-based installation
Mark this to break an installation into downloadable chunks and a distributable
.EXE file.
3. Complete the following fields that are enabled:
Host Address
Enter the domain name or IP address of the Web or FTP host that will hold the
installation files.
Host Username, Host Password
Enter the user name and password required to log onto the server. If this is left
blank, an anonymous logon is performed.
It is a good idea to use password protection so that casual users of your W eb or
FTP server do not stumble across the WebDeploy files, and also to make sure
that only users with the installation stub .EXE can access them. Because
everyone with a copy of the installation .EXE uses the same user name and
password, this is not suitable for tracking individual user access to the Web site.
Host Directory
Enter the path to the WebDeploy files stored on the server.
File Transfer Via
Select how to transfer the files:
HTTP Protocol
This option is more universal because it can be used both outside and behind
a firewall. The HTTP protocol tries to read the information from the Web
browser, which makes your files more widely available to your clients. It also
allows for faster file transfers than the FTP protocol. Because of its flexibility
and proxy server support, we recommend the use of the HTTP protocol.
FTP Protocol
This option is used within an intranet for organizations that deploy their
software behind a firewall. It works through WinSock, so you must have a
valid WinSock layer for it to work. Using this protocol requires a name and a
password. WebDeploy fails if the server allows anonymous logon without a
password.
WiseScript Package Editor Reference83
To have the FTP protocol work through a proxy server, see the workaround
solution in the sample script Proxy.wse, in the WiseScript Editor\Samples
subdirectory of this product’s installation directory. For details on sample
scripts, see ScriptHelp.htm in the Samples subdirectory in this product’s
installation directory.
Page 84
Cluster Size
Enter a number in kilobytes. Files smaller than the cluster size are packed into
data files up to the cluster size. Files larger than the cluster size make up their
own data file. A smaller cluster size increases the transfer rate of data. It also
minimizes the amount of files that a given installation must download because
only the necessary files are downloaded.
Example:
An installation has four 5 K files and one 50 K file. You set the cluster size to 20
K and compile. You end up with a 20 K file, packed with the four 5 K files, and a
50 K file.
4. Save, compile, and close the installation.
See also:
WebDeploy on page 81
The WebDeploy Process on page 82
Uploading a WebDeploy Installation to the Web on page 84
Uploading a WebDeploy Installation to the Web
Creating WiseScript Installations
To upload the files in a WebDeploy installation, you can use any FTP client.
To upload a WebDeploy installation with an FTP client
1. Verify that a directory exists on the Web server at the address you specified on the
WebDeploy page.
2. Using an FTP client, upload the installation files.
3. Distribute the installation media or notify your end users of the W eb link to the .EXE.
To test the installation
After the files are uploaded to the server, you can test your application by connecting to
the FTP server through an FTP client and downloading and running the installation .EXE.
WebDeploy downloads and installs only the files that a particular end user requires,
skipping those files that are the same version as existing files on the destination
computer. To determine which files can be skipped, WebDeploy uses the Microsoft
VER.DLL. If the Internet connection is interrupted during the download, WebDeploy
picks up where the installation was cut off when download resumes.
See The WebDeploy Process.
See also:
WebDeploy on page 81
Creating a WebDeploy Installation on page 82
WiseUpdate
For information on using WiseUpdate, see Using WiseUpdate in an Installation on
page 87.
WiseScript Package Editor Reference84
Page 85
Chapter 5
Using WiseUpdate
This chapter includes the following topics:
zAbout WiseUpdate on page 85
zThe WiseUpdate Process on page 86
zUsing WiseUpdate in an Installation on page 87
zOptions for Running WiseUpdate Client on page 91
zWiseUpdate Tips on page 92
zTroubleshooting WiseUpdate on page 93
About WiseUpdate
¾ WiseScript Package Editor 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 (WiseUpdt.exe) 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 destination computer is started or an end user logs on to Windows.
WiseUpdate Client checks for newer versions of your application at the W eb location you
specified. If it finds a new installation, it downloads and runs it.
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 ove r 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. See
Configuring the WiseUpdate Page on page 87.
Note
This documentation covers both WiseScript Package Editor and WiseScript Editor.
WiseScript Editor contains the same scripting interface as WiseScript Package Editor, but
it does not contain the Installation Expert interface or other installation development
tools. Therefore, some of the information in this document does not apply to WiseScript
Editor.
WiseScript Package Editor Reference85
Page 86
The WiseUpdate Process
¾ WiseScript Package Editor only
Using WiseUpdate
Phase 1:
When you first use WiseUpdate, you:
1. Develop the installation
2. Configure WiseUpdate and
specify:
Location of updates on the Web
server
Current version of the
application
3. Upload to the Web server:
WiseUpdate update file
Installation files and Readme
Your Computer
(FTP)
Phase 2:
The end user:
1. Obtains your application through normal distribution channels
2. Installs your application:
WiseUpdate Client is copied to the application directory
A shortcut to WiseUpdate client is placed on the destination computer
Phase 3:
When you update your application to
a new version, you:
1. Develop an upgrade or patch
2. Configure WiseUpdate and
specify:
Same Web location as the
original
New version of the application
3. Upload to the Web server:
WiseUpdate update file
Installation files and Readme
Your Computer
(FTP)
Your Web Server (FTP/HTTP):
z Contains the WiseUpdate
update file that stores:
The current version number
URLs to the installation files
z Contains the installation files
and Readme
Destination Computer
Your Web Server (FTP/HTTP):
z Contains the WiseUpdate
update file that stores:
The new version number
URLs to the new installation
files
z Contains the new installation
files and Readme
Phase 4:
When WiseUpdate Client is run on the destination computer, it:
z Runs an upgrade wizard
z Reads the WiseUpdate update file on the Web server
z Determines that a new version exists
z Displays the Readme
z Downloads and runs new installation files
z Updates the local version
Destination ComputerYour Web Server (FTP/HTTP)
(HTTP)
WiseScript Package Editor Reference86
Page 87
Using WiseUpdate in an Installation
¾ WiseScript Package Editor only
To use WiseUpdate® effectively, you must use it in two or more successive versions of
your application. Using it in one version of your application only enables that version to
check for later versions over the Internet.
Note
To avoid web connection errors when you use WiseUpdate with IIS 6.0 or later, you
must add a MIME type to the IIS server for each type of file that you let users download
from the Internet.
Process for Using WiseUpdate Effectively
1. Select Installation Expert > WiseUpdate page.
2. Mark Include WiseUpdate Client.
This causes WiseUpdate Client, a small executable file (WiseUpdt.exe), to be
included in the in stallation and in stalled on the des tination comput er in the main
application directory along with your application.
Using WiseUpdate
3. Configure the WiseUpdate page.
See Configuring the WiseUpdate Page on page 87.
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.
See Uploading WiseUpdate Files With an FTP Client on page 90.
Warning
If you do not upload the files before deploying your application to end users, an
error occurs when they check for upgrades.
5. Test the WiseUpdate process.
See Testing WiseUpdate on page 90.
6. Distribute your application using your usual method. Examples: CD or WebDep loy.
7. The next time you update your application, do the following:
a. Format it as an upgrade or a patch.
b. Update the Version field on the Product Details page, otherwise the
maintenance mode will be entered.
c.Upload the updated installation files to the Web server.
After you upload the updated application, end users who have WiseUpdate will be
prompted to update their application over the Internet.
Configuring the WiseUpdate Page
¾ WiseScript Package Editor only
Completing the WiseUpdate page causes the WiseUpdate Client to be installed in the
application directory on the destination computer along with your application. Most of
WiseScript Package Editor Reference87
Page 88
Using WiseUpdate
the fields on this page specify information to be embedded inside WiseUpdate Client.
This information tells the client when, how, and where to check the Web location for new
versions.
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.
1. Select Installation Expert > WiseUpdate page.
2. Mark Include WiseUpdate Client.
3. Complete the page:
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—you typically use 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 92.
Host Username
If necessary, enter the user name 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 89.
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.
Check Interval (days)
WiseScript Package Editor Reference88
Enter the frequency at which to remind the end user to check for updates. This
works in conjunction with the Add client to StartUp group check box below.
If you place the WiseUpdate shortcut in the StartUp group on the destination
computer, WiseUpdate Client runs when the destination computer is started or
Page 89
Using WiseUpdate
the end user logs on to Windows. If the check interval has been reached,
WiseUpdate Client runs normally , prompt ing the end user to check for updates.
If the check interval has not been reached, WiseUpdate Client runs silently and
quits.
Alternate Web Page
Enter a URL to direct the end user to if WiseUpdate Client cannot check for
updates or download the installation files. You might direct the end user to a
Web page that contains technical support information, upgrade information, or
a discussion of possible problems.
Start Menu Icon
This is enabled when you mark the Add client to StartUp group check box
below. Enter a name for a shortcut to be created in the Startup group of the
destination computer’s Windows Start menu. This name cannot contain special
characters such as /, :, *, or ?.
Add client to StartUp group
Mark this to have the installation add a shortcut for WiseUpdate Client to the
Startup group of the Windows Start menu on the destination computer. Then,
when the destination computer is started or the end user logs on to Windows,
the shortcut runs WiseUpdate Client according to the Check Interval (days)
setting described above.
If you do not mark this check box, then WiseUpdate Client will never run on the
end user’s computer unless you code your application to run it.
See Options for Running WiseUpdate Client on page 91.
About the WiseUpdate Update File
¾ WiseScript Package Editor only
On the WiseUpdate page, you enter a name for the WiseUpdate update file, which is
created during compile. Later, the update file is uploaded to a Web server. When
WiseUpdate Client runs on the destination computer, it reads the update file to
determine if a new version exists, and if so, where to find the new version and its
Readme.
The update file is in .INI format and contains information that you enter on the
WiseUpdate page. It is formatted as follows:
zVersion is the version of installation that is available on the server.
zSize is the size of the installation in bytes.
zInstall is the URL to the installation.
zReadMe is the URL to the installation’s Readme file. If there is no Readme file, the
Readme line is omitted.
WiseScript Package Editor Reference89
Page 90
Uploading WiseUpdate Files With an FTP Client
¾ WiseScript Package Editor only
Use an FTP client to upload the following items to the Host Address and Host
Directory you specified on the WiseUpdate page:
zThe compiled installation file or files.
zAn optional Readme file.
zThe 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 89.
You can place the i nstallation files and R eadme at an y 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
Using WiseUpdate
¾ WiseScript Package Editor only
After you configure the WiseUpdate page and upload files to the FTP server, you should
test the WiseUpdate process.
To test how WiseUpdate works when an update is not needed
In this test, the end user’s version of your application matches the version on the Web
server.
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 doubleclick the file WiseUpdt.exe. Normally, this file is run automatically at prescribed
intervals at startup, but for testing purposes, you run the .EXE directly.
WiseUpdate Client opens, customized with your application’s name.
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.
4. Close the WiseUpdate Client window.
If this test is not successful, try to determine the problem.
See WiseUpdate Tips on page 92 and Troubleshooting WiseUpdate on page 93.
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.
WiseScript Package Editor Reference90
Page 91
Using WiseUpdate
To test how WiseUpdate works when an update is needed
1. To make the application on the server appear to be a later version:
a. On your development computer, on the WiseUpdate page, enter a later product
version. (Example: If the original version was 1.0.0, enter 1.0.2)
b. Compile the installation to create a new update file.
c.Upload the new update file to the Web server.
2. On the testing computer, open your application’s installation directory and doubleclick 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. To restore the correct version information to the server, repeat step 1, except enter
the original product version.
If this test is not successful, try to determine the problem.
See WiseUpdate Tips on page 92 and Troubleshooting WiseUpdate on page 93.
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 through HTTP, or
the necessary files were not found on the host.
Options for Running WiseUpdate Client
¾ WiseScript Package Editor only
Options on the WiseUpdate page determine how WiseUpdate Client (WiseUpdt.exe) is
run on the destination computer.
Run Silently From a Shortcut on the Destination Computer
zOn the WiseUpdate page, mark the Add client to Startup group check box and
enter a value in the Check Interval (days) field.
zThe installation adds a shortcut for WiseUpdate Client to the Startup group of the
Windows Start menu on the destination computer.
zWhen the destination computer is started 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.
Run From Your Application
zOn the WiseUpdate page, clear the Add client to Startup group check box.
Entering a value in the Check Interval (days) field is optional.
zCode your application to open the file WiseUpdt.exe from the application directory,
in either of the following ways:
WiseScript Package Editor Reference91
Page 92
Run WiseUpdate Client when the application is run.
Add a menu command in your application to run WiseUpdate Client.
WiseUpdate Tips
¾ WiseScript Package Editor only
Can WiseUpdate be used with WebDeploy?
Yes. Make sure th at update installations y ou release are formatted as upgr ades (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 run 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.
Using WiseUpdate
To use the check interval value from the WiseUpdate page, run WiseUpdate
Client with the /c command-line option. Then 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.
Because the .EXE of an .MSI/.EXE pair might contain optional runtimes (examples:
Windows Installer or .NET runtimes), WiseUpdate always tries to open the .EXE, not the
.MSI. Follow these guidelines:
zThe .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 email or other
mechanisms.
zOn the WiseUpdate page, the connection information you enter must point to the
location of the WiseUpdate update file on the Web server.
See WebDeploy on page 8 1.
Can WiseUpdate be used with SmartPatch?
Because WiseUpdate is meant to work for updates, you can easily use SmartPatch to
create the updated version that end users download using WiseUpdate. That way end
users only have to download the smaller patch file instead of the entire installer.
See SmartPatch on page 74.
Does WiseUpdate work if the Web location of the WiseUpdate update
file changes?
No. Once you start using WiseUpdate, all subsequent versions of the WiseUpdate update
file must be located in the same directory as the original. This is because the
WiseUpdate Client that’s already on end user’s computers only knows to view 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.
WiseScript Package Editor Reference92
Page 93
Why are there two different fields that accept the product version?
During the WiseUpdate process, you encounter two different fields that require a
product version. How are these fields related?
zThe 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.
zThe 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. It also sets the version that is stored in the WiseUpdate update
file.
Typically, both fields should have the same version number, but you can change the
versions to force upgrades.
Troubleshooting WiseUpdate
¾ WiseScript Package Editor only
If you encounter problems with WiseUpdate during testing or after deploying your
application, check the following suggestions.
Using WiseUpdate
zUse 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.
zWiseUpdate Client uses HTTP to connect to the Web server specified on the
WiseUpdate page. You typically use 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.
zUpdates for Windows Installer installations must be in the form of an upgrade or
patch. If the end user has version 1.0.0 of your application installed, and you make
some changes to it and upload it with a new version number, the WiseUpdate
upgrade will fail unless you configured the updated package as an upgrade (using
the Upgrades page) or a patch (using Patch Creation).
zIf end users cannot view the Readme file in WiseUpdate Client, make sure the
Readme file does not have embedded graphics, which are not supported.
zIf the Associated Application Not Found dialog box appears when the WiseUpdate
client is started, then you might not have entered a title in the Installation Title
field on the Product Details page. Be sure to enter a installation title name when
using WiseUpdate.
WiseScript Package Editor Reference93
Page 94
Chapter 6
Using Script Editor
This chapter includes the following topics:
zAbout Script Editor on page 94
zThe Script Editor Window on page 95
zTypes of Scripts on page 97
zAdding an Action to a Script on page 99
zEditing Scripts on page 99
zAbout User-Defined Actions on page 101
zUsing the Debug Commands on page 106
zBasic Scripting Concepts on page 109
About Script Editor
Note
This documentation covers both WiseScript Package Editor and WiseScript Editor.
WiseScript Editor contains the same scripting interface as WiseScript Package Editor, but
it does not contain the Installation Expert interface or other installation development
tools. Therefore, some of the information in this document does not apply to WiseScript
Editor.
All WiseScript products contain the Script Editor scripting en vironment. The Script Editor
scripting environment consolidates numerous lines of code into predefined script
actions. You don’t need to memorize commands because Script Editor supports a pointand-click method of scripting. The script you create is displayed in clear, English-like
statements. You compile the script, along with files and other resources, into an .EXE.
When the .EXE is run, the script runs, executing the actions that are specified in the
script.
In WiseScript Package Editor, every i nstallation is driv en by a script that specifies how to
display dialog boxes, edit the .INI files, add registry entries, and so on. The script
provides another way of looking at the installation you create in Installation Expert.
Script Editor lets you add advanced functionality to your installation and troubleshoot
your script with the built-in debugger.
(WiseScript Package Editor only) If you create a new inst alla tion by selecting Empty Project on the New Installation File dialog box, Script Editor is populated with a default
script in which the basic elements of an installation are already configured. If you create
a new installation by selecting Blank Script on the New Installation File dialog box,
Script Editor is empty. If you start from a blank script and then try to switch to
Installation Expert, you see a warning that the script must be converted.
See Switching Between Installation Expert and Script Editor on page 17.
(WiseScript Package Editor only) Some lines in the sc ript correspond to options on pages
in Installation Expert because those options generate script lines. (Example: On the
WiseScript Package Editor Reference94
Page 95
Product Details page, you enter InstallationName in the Installation Title field. The
following line is generated in the script: Set Variable APPTITLE to InstallationName.)
The Script Editor Window
The Script Editor window contains all the tools necessary to develop and edit
WiseScripts. To access Script Editor, click Script Editor at the lower left of the main
window.
Title
Using Script Editor
Event and
Language dropdown lists
Actions list
Script list
Tabs for the main
script and each
include script or
VBScript
Compile, Test, and RunView Navigation
Title
This field contains the script’s name. By default, it is the name entered in the
Installation Title field on the Product Details page followed by “Installation.” If you
change the title of the script here, it does not change on the Product Details page. When
you run the installation, this name appears at the top of the splash dialog box (the
Initializing Wise Installation wizard dialog box), and in the title bar of the installation
screen.
Event
From this drop-down list, you select the script to edit. The Mainline script is the script
that typically contains installation instructions.
See Customizing the List of Actions on page 97.
WiseScript Package Editor Reference95
Page 96
Using Script Editor
Language
From this drop-down list, you select a language for the WiseScript. This drop-down list
includes all the languages that are supported in the installation. You specify the
supported languages on the Languages page.
See Languages on page 58.
When you add a script line or custom dialog box that presents text to the end user,
select each language in the Language drop-down list, and edit that script line so it
contains the translated text. (Example: You set an installation to support French and
English on the Languages page. While in the English script, you add a Display Message
script line that states, “Do you want to view the ReadMe file now?” You should then
select French from the Language drop-down list and edit the script line you just added
with a French translation of the message.)
Actions
The actions are arranged in groups under title bars. If you click the All Items title bar,
it displays all the actions you can add to your script. The SVS Items group displays SVS
specific actions, the Favorites group displays some of the most commonly used actions,
while the Custom group is by default empty. You can also create your own action
groups.
See Customizing the List of Actions on page 97.
Script List
This list contains the script that is executed when an end user runs the .EXE.
For information on working with scripts, see Adding an Action to a Script on page 99 and
Editing Scripts on page 99.
Script lines are color-coded based on the type of the script line. The color code is as
follows:
zCompiler Variable Items - gray
zInclude Script Items - black
zInstall/Copy File Items - black
zLogic items - blue
zNew Variable Values - red
zRemarks - gre en
In WiseScript Package Editor, you can change the color code in Preferences.
See Setting Preferences on page 25.
Script Tabs
A tab for the current installation script appears at the bottom of the installation script
area. When you add an Include Script or VB Script action to the current installation
script, a tab for that script appears next to the tab for the current installation script.
To show tabs for Wise include scripts, mark the Show Tabs for Wise Include Scripts
check box in Preferences.
Script Line Numbering
zTo show or hide script line numbers, select View menu > Line Numbers.
WiseScript Package Editor Reference96
Page 97
zConnection lines connect the beginning and end of an If block or a loop. To show or
hide connection lines, select View menu > Connection Lines.
Customizing the List of Actions
Script Editor contains four default action groups: All Items, SVS Items, Favorites,
and Custom. You can add up to 10 additional groups and add any actions that appear in
the All Items group to any other group. The All Items group contains all actions, and
you cannot remove this group or any of its actions. You can remove any of the other
groups and edit the actions that appear in the groups.
To add an action group
1. Right-click anywhere in the Actions list and select Add Group.
The Group Name dialog box appears.
2. Enter the name of the new group and click OK.
The Select Items for Group dialog box appears.
3. Select the actions to include in the group and click OK.
The new action group appears with the actions you selected.
Using Script Editor
To edit an action group
1. Click the title bar of the action group.
You cannot edit or remove the All Items group.
2. Right-click below the action group title bar and select Add/Remove Items.
The Select Items for Group dialog box appears.
3. Add, delete, or move group items and click OK.
You can customize the Actions list further by creating user-defined actions.
See About User-Defined Actions on page 101.
Types of Scripts
In Script Editor, you can edit the following scripts:
Event Scripts
Event scripts handle events. (Example: The end user cancels the installation.) You can
select from the Event drop-down list and edit:
zMainline
The primary script that’s executed during the normal installation process. It
contains placeholders for Cancel and Exit scripts. When you open a script, that script
is considered the “main installation script,” and is on the first tab below the
installation script.
Changes in the main installation script are reflected in Installation Expert and vice
versa.
WiseScript Package Editor Reference97
Page 98
Using Script Editor
zExit
The script that’s executed when the installation is complete, or when an Exit
Installation script command is executed. If you create a user-defined action, you
store its custom dialog box here.
See Creating a User-Defined Action on page 102.
zCancel
The script that’s executed when the end user cancels the installation. Because some
files might already be installed when the end user cancels, the Cancel script
contains the include script, rollback.wse, which returns the destination computer to
its pre-installation state.
Include Scripts
Include scripts are added to an installation with an Include Script action.
See Include Script on page 172.
Scripts can be included either in the main installation script or in other include scripts. At
run time, include scripts are run when the Include Script action that references them is
encountered. For each Include Script action in a script, a new tab appears at the bottom
of the Installation Script pane.
In WiseScript Package Editor, mark the Show Tabs for Wise Include Scripts check
box in Preferences to show tabs for Wise include scripts.
See Setting Preferences on page 25.
Include scripts can help save time in developing installati ons, because you can develop a
library of WiseScripts that perform very specific functions. You can re-use these
specialized scripts in future installations and easily share them with colleagues.
(WiseScript Package Editor only) By default, all scripts based on the Empty Project
template on the New Installation File dialog box contain two include scripts: rollback.wse
and uninstal.wse. The rollback.wse script is in the Cancel event script and is executed if
the end user cancels the installation after it starts. If the end user chooses to back up
replaced files, this script will roll the destination computer back to its pre-installation
state. The uninstal.wse script adds uninstall support to each new installation.
VBScripts
VBScripts are added to an installation with an Execute VBScript action.
See Execute VBScript on page 157.
VBScripts can be included either in the main installation script or in include scripts. At
run time, VBScripts are run when the Execute VBScript action that re ferences them is
encountered. For each Execute VBScr ipt action in a WiseScript, a new tab appears at the
bottom of the Installation Script pane. When you click this tab, a VBScript window
appears.
See Editing a VBScript on page 158.
By adding VBScripts, you can greatly expand the functionality of WiseScripts because
you can use all the scripting capabilities of VBScrip t (example: arr ays and subfunctions).
Adding VBScripts can also save you time because you can use scripts that others have
created.
WiseScript Package Editor Reference98
Page 99
Adding an Action to a Script
in Script Editor, do any of the following:
zFrom the Actions list in the left pane, drag an action onto a line in the Installation
Script list in the right pa ne. The new action appears above the line that is
highlighted when you drop the action.
zClick in the script and double-click the action in the Actions list to place the new
action above the line you clicked.
zClick in the script and start typing the first few letters of the action name. As you
type, the current line becomes a drop-down list with all the action names, and the
action that most closely matches the letters you typed is the current item in the list.
When the action you want is the current item in the list, press Enter.
Note
(WiseScript Package Editor only) To insert lines below the line you selected, mark the
Append New Items option in Preferences.
See Setting Preferences on page 25.
When you add an action, a dialog box appears that lets you set the parameters for the
action unless it does not require parameters. When you add a Custom Dialog or Custom
Billboard action, the appropriate editing environment opens.
Using Script Editor
Some actions come in pairs. (Example: When you add an If action, you must also add an
End action at the end of the condition block.) Script Editor indents actions inside these
pairs.
Use the same methods to add an action to a VBScript.
See VBScript Actions on page 159.
Editing Scripts
To edit a WiseScript in Script Editor, use the commands on the Edit menu, the
commands on the right-click menu, or the tools on the toolbar. You can edit only one
script line at a time, but you can cut, copy, or paste several lines at one time.
To edit an include script, select it by clicking its tab. Changes that you make to an
include script are saved when you save the project.
To edit a VBScript, see Editing a VBScript on page 158.
Editing Script Action Parameters
Double-click the action in the script. For most script actions, a dialog box appears so you
can configure its parameters. When you double-click a Custom Billboard or Custom
Dialog action, the appropriate editing environment opens.
Copying and Pasting Script Lines
1. Select one or more script lines.
2. Select Edit menu > Cut or Copy.
3. If you’re copying the lines to another installation, open that installation script in
Script Editor.
WiseScript Package Editor Reference99
Page 100
Using Script Editor
You cannot open multiple scripts in the same instance of WiseScript Package Editor
unless it is an include script or VBScript. However, you can open multiple instances
of WiseScript Package Editor, and open different scripts in each.
See Customizing the List of Actions on page 97.
4. Select a line in the script above which to place the lines you copied, then select Edit
menu > Paste.
The lines appear above the line you selected.
Duplicating or Moving Script Lines
1. Select one or more script lines.
2. Select Edit menu > Duplicate, or Edit menu > Move Up or Move Down.
Commenting Out Script Lines
You can temporarily comment out certain script lines to help with the debug process.
Commented out lines remain in the script, but are skipped when the script is execute d.
1. Select one or more lines.
2. Select Edit menu > Comment.
The commented out lines appear in green and begin with “/*”. To reactivate
commented out lines, select the lines and select Edit menu > Comment.
Saving a Script to a Text File
This text file is for viewing and printing only. You cannot make changes in the text file
and import it back into Script Editor.
1. Select File menu > Save Script Text to File.
2. Specify the location and name of the file.
Finding and Replacing Text in a Script
¾ Not available in VBScripts.
1. In Script Editor, do one of the following:
To find text, press Ctrl+F to find text.
To find and replace text, press Ctrl+H.
2. Enter the text to find.
This function searches the visible text in the script lines as well as the parameters
that are associated with the script lines.
3. (Replace function only) Enter the replacement text.
You can replace a command’s parameters and editable text, but not the command
itself.
4. To search for the text across all WiseScripts, mark Search Across Include Scripts.
For information on include scripts, see Customizing the List of Actions on page 97.
5. Click Find Next, Replace, or Replace All.
WiseScript Package Editor Reference100
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.