InstallShield MultiPlatform User's Guide · 2009-09-22 · What's New in InstallShield...

Readme for PDF of MultiPlatform 4.53User's GuideThis PDF version of the MultiPlatform 4.5 User's Guide Including Service Pack 3 differs from the one accessed in the IDE or with an external browser in the following ways:

● It does not contain duplicate topics. Therefore, its Table of Contents flow and contents are different. For example:

❍ The Custom Bean Code Examples topic is only located in Chapter 6.3 - Examples - It is not also located external to the User's Guide Contents.

❍ Action beans that are both Product and Wizard beans are only located in Chapter 2.2 - Product Actions.

● The APIs are not included. The path to where they are located on your development machine is provided rather than an actual link.

● The sample bean code ".java" files are not included. The path to where they are located on your development machine is provided rather than an actual link.

● The Tutorials and Sample Project are not included - They are separate PDF documents available as downloads from our Web Site at http://www.installshield.com/downloads.

In addition, a printout of this PDF will not include page numbers because it was created from HTML files which do not contain page numbers. Only documents that originally contain page numbers will include them when they are converted to PDF.

Welcome to MultiPlatform4.5 Including Service Pack 3Welcome to MultiPlatform 4.5 (incl. SP 3), InstallShield's cross-platform installation and configuration tool. This release of InstallShield MultiPlatform includes many enhancements and architectural-level improvements, and is designed to create powerful cross-platform wizards. Wizards perform a wide variety of tasks including product installations, environment variable updates, and system configurations.

There are several changes in this Release. For example, we have added three new fields to the User Input Panel, added the capability to set an alias on the command line, and provided a way for you to request that MultiPlatform generate two types of options/ response files for a project built with this release. For details on these and other new features, see What's New.

The MultiPlatform User's Guide, as well as the bean (context-sensitive) and Platform Help, have been enhanced to give you the most helpful, comprehensive help systems possible. The improvements to our help systems are an ongoing process as InstallShield MultiPlatform continues to grow in features and functionality. The following are the topics contained in this chapter:

● What's New ● Using the MultiPlatform Help Systems ● Interactive Project Wizards ● Contacting InstallShield Software Corporation ● Obtaining Help ● Development Environment Requirements

What's New in InstallShield MultiPlatform Release 4.5 (incl. SP 3)

● General Features ● Build Features ● Install Features ● Wizard Features ● Help Features

General FeaturesQuick Start Wizard Performance improvements have been made to the portion of the Quick Start Wizard that searches for classes with a "main" method in the

file analysis, significantly increasing the performance of its file analysis process.

Custom Beans(Not in Lite)

A new method called isInitializedForConsole has been added to the ConsoleWizardBean interface. This method supports the new capability of navigating backward through Wizard panels in console mode. Any custom wizard bean(s) that directly implements the ConsoleWizardBean interface must implement this method. These beans must be recompiled against the 4.5 SP3 JAR files. If you have a Wizard panel that extends ExtendedWizardPanel, however, there is no need to make any code changes because ExtendedWizardPanel already implements this new method, but you do need to recompile your custom beans against the 4.5 SP3 libraries.

The isInitializedForConsole method ensures that the consoleInitialize() method is called only once during console mode. The following code snippet shows a simple example of how to implement this new method:

import com.installshield.wizard.*;

public class MyWizardBean extends WizardPanel implements ConsoleWizardBean{ private boolean initialized = false;

public boolean isInitializedForConsole() { return initialized; }

public void consoleInitialize(WizardBeanEvent event) { // Perform required initialization processing ... initialized = true; }

public void consoleInteraction(WizardBeanEvent event) {

// Interact with end user on console using com.installshield.util.TTYDisplay }}

Dialog Boxes All dialog boxes from which you select to add a software object, e.g., action, condition, JVM, etc., have been redesigned as follows:

● The icons have been removed so that only an alphabetical list of objects display. ● A Search text box has been added. This search function is not case-sensitive, and the search begins as soon as characters are typed,

looking for an entry that begins with the string you have typed.

New Files Bean Filtering Properties

Two additional filtering properties have been added to the Files bean when adding a directory of files. They are "Include Files Using Filter" and "Exclude Files Using Filter". These properties can be set to include and/or exclude files that match the specified wildcard expression or GNU Regular Expression. The ability to use them in tandem and to specify multiple patterns in either field, each separated with a semicolon (;), further enables developers to delimit which files within a directory are included in that Files bean.

New "Run" Button The "Run" button in the IDE has been replaced with , which is the standard InstallShield icon.

New Scripts for Compiling Custom Beans

New scripts have been added to the "help" directory that contain all of the required classpaths to compile a custom bean. These scripts are named for the platform on which they will work, e.g., "compile.bat" works on Win32, "compile_BourneShell" works on Unix platforms with Bourne Shell, etc.

Folder Context for Linux Desktop Icons

Back to Top

The Folder Context property has been made available for Linux Desktop Icons.

Build FeaturesRunning ISMP Builder on Win32

Two new launchers are created when you install InstallShield MultiPlatform on Win32 machines. They are named and perform as follows:

● "ismpc.exe" - Executes the builder using a console launcher. This is especially useful for performing command line builds or building as part of a batch process. It does not return until the builder exits and returns the builder's exit code.

● "ismpgc.exe" - Performs exactly the same as "ismpc.exe", and also enables "is.debug" (same as "ismpg" on Unix development machines).

New Property for Win32 Launcher Beans

The Launcher bean for a Win32 platform can now create both Console and GUI launchers. There was previously no way to select which type to create at runtime. A new property, "User Interface", has been added to the Launcher Win32 properties to indicate whether the launcher should be created as a Console or GUI launcher.

Win32 Console Launcher

An additional Win32 launcher is now available. It uses a console interface rather than GUI. It is synchronous and thus does not return control to the calling process until it has finished, and returns the exit code of the Java program it executed.

Set Alias & Locale on Command Line

An Alias ("$A") and the selectedLocales property of the Product tree can now be set on the command line during a command line build.

Build Includes Only Selected Platforms

Only those beans that pertain to the Platform(s) selected in the Platform Support bean (Build Tab) are now included in the build.

Two new XSL Stylesheets

Back to Top

Two new XSL Stylesheets have been added to the "help" directory:

● "setVersion.xsl" - Once edited by the developer for a specific patch or update project, changes the Key version properties for all of the Product beans in the Product Tree.

● "omitInactiveComponents.xsl" - Steps through the specified project and deletes every Component that has its Active property set to "False" so that they will not be included in the JAR file when the project is built.

Install Features"Hashed" Passwords Now Used

In previous releases, the Password Panel responded to the command line command -G Password= when used, for example, in a response file for a silent installation. Effective with this release, a "hashed" password must now be used. To obtain the hashed password, the developer runs the Password Panel as a Java application via a command line command. In addition, the hashed password must now also be used to set the password in a command line command.

New Property in Text Display Panel

A new property - File Encoding - Has been added to the Text Display Panel. This property is only used when the panel's Text Source property is set to "Local File", and specifies the Java encoding that should be used for converting the bytes in the local file to a Java String at runtime. If this property is left blank, the installer uses the default encoding of the JVM on the target machine.

Applet Applet installations now support Sun's JRE plugin 1.3.1 or higher, as well as native browser JVMs.

Linux RPM Check Install Panel Removed

Installing to Linux platforms is no longer dependent upon the rpmspec/rpmspec4 binaries being available on the target machine. Therefore, the "Linux RPM Check Install Panel" is no longer required in the Installer or Uninstaller Tree. When a project that was created with an earlier release of MultiPlatform is opened, any instance of this bean is automatically removed. You will still see, however, the same level of integration with RPM for those Product components that target Linux.

Automatic Generation of Options/Response Files

For projects built with Release 4.5 Including Service Pack 3, ASCII options/response files can be automatically generated that are specific for the Wizard, via command line options. There are two types of options/response files that can be created:

● "Response" File - Contains the literal values returned by getOptionsTemplateValueStr, and can be used to provide user input during, for example, a silent installation. The "Options" file that MultiPlatform generates for the specified project must be edited to contain the response(s) required by the installation. See SampleResponseFile.txt in the "help" directory where MultiPlatform is installed.

● "Records" File - Is generated by MultiPlatform after the completion of the installation/uninstallation. It lets the wizard run and then creates the file when the wizard exits (at the time wizardFinished is called), storing the values of the applicable wizard state properties in the file. This is useful for saving a record of a specific wizard execution session which can later be reused in a silent or modified installation. See SampleRecordsFile.txt in the "help" directory where MultiPlatform is installed.

file:///Y|/Help%20Stuff/SampleResponseFile.txtfile:///Y|/Help%20Stuff/SampleRecordsFile.txt

Localized Splash Screen & Billboard Images

The image files, i.e., GIF and JPEG/JPG files, used for a splash screen and billboards can now be localized.

User Input Panel The following enhancements have been made to the User Input Panel:

Three new field types have been added:

● File browser field - Displays a browser dialog box that enables the end user to browse and select a specific file. ● Directory browser field - Displays a browser dialog box that enables the end user to browse and select a specific directory. ● Password field - Enables the use of a password to continue the installation. The characters entered by the end user are echoed back

as asterisks ("*").

The ability to respond to a User Input Panel via an Options/Response File has been added. In conjunction with this capability, a new property - Options File Documentation - Has been added to all fields in this panel to enable developers to describe the purpose/function of the field in the Options/Response File.

Improved Console Installation Experience

The end user experience during a console installation has been improved. They can now go back, exit, and redisplay within console mode. In addition, exiting the wizard properly cleans up the temporary files, panels are delimited with a dashed line for increased readability, and the prompts have been revised to eliminate references to GUI type actions such as "click".

Destination Directory Validation

The destination directory validation mechanism has been enhanced to support file name validation via a new method in the FileService, which is utilized by the Destination Panel and the Product bean command line option when the installLocation is being set. It checks that the specified file name or path does not contain any invalid characters.

Approval Panel in Console Mode

A new property has been added to the Approval Panel - Console Choice Caption - Which appears in console mode only above the Approval and Disapproval Captions, giving the end user the context for choosing one of the options that follow. This property is resolved before it displays.

Root Display Name Property Added to Feature Panels

Back to Top

A new property - Root Display Name - Has been added to the Feature and Uninstall Feature Panels. This property displays directly above the list of features to be installed/uninstalled, and is localized.

Wizard FeaturesTextInputComponent When TextInputComponent is used for obtaining a password, it now masks the value entered by the end user while in console mode.

Accessibility Mode Command Line Option

The new Accessibility Mode command line option (-accessibility) makes the runtime console mode Wizard more friendly for screen readers, e.g., renders the percent complete from the Install Action differently, etc.

Help Features

Localized ("$L") String Resources

The default localized ("$L") English string resources that are included in MultiPlatform are now listed alphabetically, along with their definition, by type of bean: "Product", "Wizard", and "Wizardx". These have been added to Chapter 8.4 - String Resolution and Localization, and include instructions on how to locate a specific bean's resource string.

New XSL Stylesheets Two new XSL Stylesheets have been added to the "help" directory:

● "setVersion.xsl" - Once edited by the developer for a specific patch or update project, changes the Key version properties for all of the Product beans in the Product Tree.

● "omitInactiveComponents.xsl" - Steps through the specified project and deletes every component whose Active property set to "False" so that they will not be included in the JAR file when the project is built.

New Compile ScriptsNew scripts have been added to the "help" directory that contain all of the required classpaths to compile a custom bean. These scripts are named for the platform on which they will work, e.g., "compile.bat" works on Win32, "compile_BourneShell" works on Unix platforms with Bourne Shell, etc.

Access to Win32 APIs

Direct access to the Win32 APIs have been added to the MultiPlatform User's Guide, Chapter 7 - Platform Packs.

Back to Top

file:///Y|/Help%20Stuff/HTMLs%204%20PDF/Topics/ProductResources.htmfile:///Y|/Help%20Stuff/HTMLs%204%20PDF/Topics/WizardResources.htmfile:///Y|/Help%20Stuff/HTMLs%204%20PDF/Topics/WizardXResources.htm

Contacting Software Corporation

You may contact InstallShield Software Corporation from anywhere in the world by visiting our web site at:

http://www.installshield.com

InstallShield Software Corporation Locations

United States

InstallShield Software Corporation900 National Parkway, Suite 125Schaumburg, IL 60173-5108USA

European Union

InstallShield UK OfficeInstallShield Software LimitedKings House14 Orchard StreetBristol, BS1 5EHUnited Kingdom

Rest of the World

InstallShield Software Corporation900 National Parkway, Suite 125Schaumburg, IL 60173-5108USA

Obtaining Help

Additional information about using InstallShield MultiPlatform can be obtained from the following resources:

Resource Description

APIs

MultiPlatform includes extensively documented APIs that are available for simplification of custom bean development, improved evolution strategy for bean data definitions, and improved access to core wizard APIs. To access, click the Help link in the far left panel of the IDE, then click API.

Field-level Help Also referred to as "Bean Help" or "Context-sensitive Help", provides information about a selected bean's properties, and displays in the far right panel of the IDE.

MultiPlatform User's Guide

Provides online help by topic, step-by-step instructions for performing specific functions, and complete information about using InstallShield MultiPlatform. This User's Guide is also available

● to view in a separate IDE. Click in the far, right corner of the

top of the IDE. ● to view with/print from an external browser. Double-click

HelpIndex.html in the help directory where MultiPlatform is installed.

Platform Help Provides platform-specific information for each Platform Pack included with InstallShield MultiPlatform. To access, click the Help link in the far left panel of the IDE, then click the Platform Help link, then click the platform for which you need information.

Project Wizard An interactive wizard that takes you through the steps to create an installation project. The Project Wizard actually creates the selected project right in the IDE. To use the Wizard, leave the checkmark in the box next to Configure With Wizard in the New Project dialog box.

Training After participating in our courses, you’ll understand the advanced features of your product and know how to create solutions for complex software distribution and deployment requirements in less time.

The time you spend in an InstallShield Training course is focused on helping you learn every technique and feature available in your InstallShield software solution so that you deploy faster, author with more custom skill and control, and meet the specific, strategic requirements of your organization. We want to help your company deliver a more robust installation with more efficient development and quicker time-to-market for your important applications. And we want to help you advance your skill set, learn valuable techniques from an industry leader, and share your experiences with fellow attendees and technical InstallShield staff. Our goal is to provide educational excellence and "tell-a-friend" value. Every time.

For more information about InstallShield Training, visit our Web Site at http://www.installshield.com, and click Training.

Tutorials Provide step-by-step instructions and information about using and customizing MultiPlatform. Tutorials are available to view and/or print for the following topics:

● Installations (Wizards) ● Developer (Creating/Using Custom Beans) ● Advanced (Command Line Usage and XSL)

To access, click the Help link in the left panel of the IDE, then click Tutorials. A PDF of the Tutorials is also available for downloading from our Web Site at http://www.installshield.com.

Web Site Support The following information is available at the InstallShield Web Site at http://www.installshield.com:

● Knowledge Base ● Reference Center ● News Groups ● White Papers ● Consulting Information ● Feedback Forms

MultiPlatform Development and End User Environment Requirements

● A supported platform ● 100 MB of hard disk space ● 128 MB RAM ● 200+ MHz processor ● A Java virtual machine (JVM) or runtime environment (JRE)

End User/Target Machine Requirements

System requirements for running an installation created by InstallShield MultiPlatform might vary slightly depending on the specified output format. End users need a JVM/runtime environment of 1.1.8 or higher on the target system. With InstallShield MultiPlatform, you can require that a particular JVM be installed on the target system before installation continues, or you can bundle a JVM with your application.

Output formats include:

● Native Executable File - Can be platform-specific ● Web Applet - Requires Microsoft Internet Explorer 4.0+ or Netscape Communicator 4.05+ ● JAR File - A simple double-click if the end user has JVM 1.2.2+

Platform Release JVM(s)

AIX

IBM 4.3.2 IBM JVM 1.1.6

IBM 4.3.3 IBM JVM 1.1.8, 1.3.0, 1.3.1

IBM 5.0.0 & 5.1.0/5L IBM JVM 1.3.0, 1.3.1

HP-UX10.20, 11.0 JVM 1.1.8, 1.2.2, 1.3.0, 1.4.0

11.i / 11.11 JVM 1.1.8, 1.2.2, 1.3.0, 1.3.1, 1.4.0

Linux

Caldera

Red Hat 6.2, 7.0-7.2

SuSe 6.2-6.4

Turbo 6.0

Sun JVM 1.2.2, 1.3.0IBM JVM 1.1.8, 1.3.0Blackdown 1.1.8, 1.2, 1.2.2, 1.3.0

Red Hat 7.0-7.2 Sun JVM 1.3.1IBM JVM 1.3.0Blackdown 1.1.8, 1.3.1

Red Hat 6.2, 7.1, 7.2 Sun 1.4.0

OS/2Warp 4.0, Warp Server IBM JVM 1.1.8, 1.3.0, 1.3.1

For Runtime - IBM JVM 1.1.7a+

OS/400V4R4M0+V5R1

IBM JVM 1.1.8, 1.2, 1.2.2

SolarisSun 2.6 - 2.8 SPARC

Sun JVM 1.1.8, 1.2.2, 1.3.0, 1.4.0Sun 2.6 - 2.8 INTEL

Windows

9x/2000 Sun JVM 1.1.8, 1.2.2, 1.3.0IBM JVM 1.1.8, 1.2.2, 1.3.0Microsoft JView 5.00Sun 1.4.0 (9x & NT Including Service Pack 5)

Me

NT 4.0+

XP (32-bit) Sun 1.2.2, 1.3.0IBM JVM 1.2.2, 1.3.0Microsoft JView 5.00Sun 1.4.0

1: For HP-UX version 10.20 only, the Registry Service requires vendor-defined attributes that are not available in this OS version.

2: If the end user is not using a supported platform, then the installation will not support any native support functionalities. See the Readme.htm file in the directory where MultiPlatform is installed for information on known issues regarding InstallShield MultiPlatform's performance on the above platforms.

If you do not have a Java Virtual Machine, one can be obtained from any of the following vendors:

● Sun: http://www.javasoft.com/products/jdk/1.2/index.html ● IBM: http://www.ibm.com/java/jdk/download/index.html ● Microsoft: http://www.microsoft.com/java

InstallShield MultiPlatform 4.53 User's Guide

The InstallShield MultiPlatform 4.5 User's Guide, also referred to as the "Online Help", has been updated to include Service Pack 3. This Guide provides developers with step-by-step instructions for building an installation project. It is structured to follow the steps required to create an installation project, with advanced information included within chapter, as well as at the end of the Guide.

Structure

The InstallShield MultiPlatform User's Guide is structured as follows:

● Welcome ❍ What's New describes all of the new and improved features and functions for the current

release. ❍ Using MultiPlatform Help describes each of the available help systems within

MultiPlatform, and provides instructions and examples of how to best use them. ❍ Interactive Project Wizards explains and describes how to create a new or modify an

existing project using the Project Wizards. ❍ Contact Information for every InstallShield location throughout the world. ❍ How and where to Obtain Help in using MultiPlatform, both within MultiPlatform and on

our Web Site at http://www.installshield.com. ❍ The Development Environment Requirements for installing and running InstallShield

MultiPlatform.

● MultiPlatform User's Guide ❍ 1.0 Getting Started describes how to do the following:

■ Use the various MultiPlatform Help Systems ■ Utilize the interactive Project Wizards to create a new project and/or modify an

existing one ■ Use the MultiPlatform Graphical User Interface (GUI) and Integrated

Development Environment (IDE) ■ Understand what is contained in a Project ■ Understand each tab, also called "view", in the IDE. Each tab's contents are also

described. ■ Create a new, open/edit an existing, and save projects ■ Utilize String Resolution, which can be used for many properties throughout

MultiPlatform. This topic is also listed throughout the User's Guide where it applies.

■ Migrate an InstallShield Java Edition 3.x Installation Project to MultiPlatform 4.+.

❍ The next three chapters are in the order in which the three tabs/views are named and sequenced in the IDE. Each section contains all of the information regarding that particular tab, in alphabetical order. Since The Installer and Uninstaller Tabs are also referred to as "Wizard" Views, Chapter 3.0 describes both views.

■ 2.0 Product Tab/View - Instructions and examples of how to use Product actions and beans, and to edit their properties in the Product Tab of the IDE.

■ 3.0 Wizards - Installer & Uninstaller Tabs/Views - Instructions and examples of how to use Wizard actions, beans, panels, and sequences, and to edit their properties in the Installer and Uninstaller Tabs of the IDE.

■ 4.0 Build Tab/View - Instructions and examples of how to create the project builder in the Build Tab of the IDE, including build configurations, localization, output messages, and platform support.

❍ The next seven chapters apply to all tabs, and are provided in alphabetical order. They are as follows:

■ 5.0 Command Line Options - Instructions and examples of how to build projects and change bean properties from the command line versus the InstallShield MultiPlatform IDE.

■ 6.0 Custom Beans - Instructions and examples of developing and utilizing your own custom beans. Much of this information is also located in the appropriate sections above (e.g., the Custom Product Bean Conditions topic is also in the Product View/Product Beans chapter). This chapter does not apply to InstallShield MultiPlatform Lite.

■ 7.0 Platform Packs - Specific Platform Pack Help is accessible from the left panel of the IDE. This chapter contains additional information regarding the use of platform-specific properties. Platform information for specific tabs is also provided in the tabs described above.

■ 8.0 Resource Bundles - Step-by-step instructions for creating a resource bundle, which is the installation of a product with localized wizard panels and/or products (e.g., panels and/or products in different languages).

■ 9.0 Services - How to utilize the API Services included with InstallShield MultiPlatform. This chapter does not apply to InstallShield MultiPlatform Lite.

■ 10.0 Suite Installations - Step-by-step instructions for creating both Multi-installer and Single-installer suite installations, which are the installation of two or more previously built products with one installation project. This chapter does not apply to InstallShield MultiPlatform Lite.

■ 11.0 Advanced Installs: Updates & Patches - Step-by-step instructions for creating both an "Update" and "Patch" installation to update or patch a product previously built and installed with MultiPlatform.

The remaining sections are located outside of the MultiPlatform User's Guide, in alphabetical

order, for faster and easier access:

❍ Bean Code Examples - Actual code for the most frequently asked for custom beans. ❍ Frequently Asked Questions (FAQs) - Answers to the questions most frequently asked

about using InstallShield MultiPlatform. ❍ Feedback - The means for you to provide feedback to the InstallShield MultiPlatform

team. ❍ Glossary - A list of commonly used terms, along with an explanation of each. Links to

related User's Guide topics that further explain the term are provided, where applicable. ❍ Sample Project - A "Sample Project", along with detailed explanations. This project

targets four platforms, and includes desktop icons, a resource bundle, and a Java application with a Launcher.

file:///Y|/Help%20Stuff/HTMLs%204%20PDF/Topics/feedback.htm

1.0 Getting Started Using InstallShield MultiPlatform

The topics contained in this chapter provide the basic information needed in order to use InstallShield MultiPlatform. These topics provide an overview of the MultiPlatform interfaces, its components, and instructions for using the various Help systems. Each of the objects that comprise an installation project are also described. The following are the subchapters contained in this chapter:

● 1.1 Using the MultiPlatform Help Systems ● 1.2 Interactive Project Wizards ● 1.3 MultiPlatform GUI ● 1.4 MultiPlatform Interface ● 1.5 Understanding Projects ● 1.6 Creating a New Project ● 1.7 Opening & Editing Projects ● 1.8 Saving Projects ● 1.9 String Resolution ● 1.10 Converting Java Edition 3.x Projects to MultiPlatform 4.x ● 1.11 VPD Registry ● 1.12 Error Code Index

1.1 Using the MultiPlatform Help Systems

In order to provide developers with as many resources as possible, InstallShield MultiPlatform includes several types of help. Below are descriptions and explanations of how each of the following types of help can be accessed and utilized:

● MultiPlatform User's Guide ❍ Document Conventions ❍ Accessing ❍ Printing

● Interactive Wizards ● Context-sensitive/Bean Help ● APIs ● Sample Bean Code ● Platform Help ● Conversion of InstallShield Java Edition (ISJE) 3.x to MultiPlatform 4.+

MultiPlatform User's Guide

The MultiPlatform User's Guide, also referred to as the "Online Help," provides step-by-step instructions for building every type of installation project. It is structured to follow the steps required to create a project, with advanced information included under each major topic. Additional information regarding different types of installations, and advanced topics such as how to create and use custom beans and command line options, are listed alphabetically in separate chapters. Throughout each topic, where a major point or function also exists as its own Help topic, a link(s) to it is provided.

A PDF of the MultiPlatform User's Guide is also available as a download from our Web Site at http://www.installshield.com.

Document Conventions

The different types of information within the MultiPlatform User's Guide are flagged and/or presented as described below:

Flag Description

The entire feature or function is not available in InstallShield MultiPlatform Lite

Not available in Lite.Only available in MultiPlatformwith iSeries/CIM pack.

Within the context of a feature or function, the feature or function is not available in InstallShield MultiPlatform Lite, or only available in InstallShield MultiPlatform with iSeries/CIM pack.

The information is critical to the success of the described function.

IMPORTANT The information could affect the success of the described function.

Additional information that should be noted.

A tip or hint that might assist in utilizing the function/feature in certain situations.

Step-by-step procedures.

Install LocationFeature 1ASCII File UpdateUser Input PanelCustom Bean Code Examples

Property, bean, action, and panel names, and MultiPlatform User's Guide topics are presented in bold type. The topics are also presented as links to the topic.

"help/ismp/Topics/SampleProject/SampleProject.xml"

Paths to specific files that are included with MultiPlatform are presented within double quotes.

Remarks Additional information that could be useful in specific situations, and is located at the bottom of the page.

See Also Links to related topics at the bottom of each page, where applicable.

Accessing the MultiPlatform User's Guide

There are four ways to access the MultiPlatform User's Guide:

● In the IDE via the Help link in the viewbar,

● in a separate view by clicking in the top, right of the toolbar, ● using an external browser, and ● viewing/printing from the external browser.

In the IDE

In the IDE, click the Help link in the far left panel. The viewbar changes to the Help menu, the MultiPlatform User's Guide Contents display in the center panel, and the Welcome page displays in the right panel of the IDE:

The Contents, navigation buttons, and access to the Index and Search functions display at the top of the center panel of the IDE.

OR

Click in the toolbar at the top of the IDE:

The Contents, navigation buttons, and access to the Index and Search functions display in a separate IDE view.

A project can not be opened, and the MultiPlatform User's Guide cannot be printed from this view.

Access to the information contained in the MultiPlatform User's Guide are obtained in the following ways:

● By Chapter/Section/Topic ● By Searching for a specific word or phrase ● From the Index ● Using the Navigation Buttons

Accessing Information by Chapter/Section/Topic

In the Contents tab in the center panel of the IDE, a plus sign ("+") and is located to the left of each chapter, section, and topic that contains related topics. To view those topics, click the "+", it changes to a minus sign ("-"), and it's subtopics display.

To view a topic, click the topic's heading, and its information displays in the right panel of the IDE:

Index

All of the topics in the MultiPlatform User's Guide are listed alphabetically by topic in the Index. To access the Index, click the middle tab at the top of the Contents list:

You can also search the Index by typing a word or phase in the text box. This function is not case-sensitive. The first matching topic displays in the right panel of the IDE:

This Search function is only available when the MultiPlatform User's Guide is opened in the IDE. If viewed using an external browser, the only available search function is the one contained in the browser, which is limited to the page that is currently displayed.

To view a topic, click the topic's heading, and its information displays in the right panel.

Searching

The Search function in the IDE provides the ability to locate information by word or phrase consisting of all ASCII characters, including embedded spaces. The right tab at the top of the Contents list provides access to the Search function:

This function is not case-sensitive.

The results of the search, which include every topic that contains the specified word or phrase, display alphabetically. The first topic that matched the search displays in the right panel.

Navigation Buttons

The four navigation buttons at the top of the center panel in the IDE function as follows:

● Back - Goes back to the topic that displayed previous to the currently displayed topic. ● Forward - Goes forward to the topic that was displayed before the Back button was clicked. ● Refresh - Reloads the current topic that is displaying in the right panel. ● Home - Returns to the "Welcome" page of the MultiPlatform User's Guide.

Accessing the MultiPlatform User's Guide With an External Browser

To view the MultiPlatform User's Guide with an external browser, double-click the "HelpIndex.html" file in the "help" directory where MultiPlatform is installed. This enables the viewing and/or printing of the MultiPlatform User's Guide while working on a project that is open in the IDE.

The entire MultiPlatform User's Guide Contents display on the left, and the "Welcome" page displays on the right. Click , it changes to , and its subtopics display.

Access to the Index is obtained by clicking the Index link at the bottom of the Contents list, and the MultiPlatform User's Guide Index displays:

Click the , it changes to , and additional topics display. To view the topics that begin with a specific letter, click that letter's link at the top of the right side of the screen. To return to the Contents, click the "Contents" link at the top of the right side of the screen.

Searching Within a Topic in the External Browser

To search for information, use the external browser's search function. This function is limited, however, to the information contained on the page that is displayed on the right side of the screen.

Printing the MultiPlatform User's Guide

While viewing the MultiPlatform User's Guide with an external browser, an individual topic or the entire MultiPlatform User's Guide can be printed.

A PDF of the MultiPlatform User's Guide can be obtained from our Web Site at http://www.installshield.com/downloads. This PDF is updated quarterly, and is easily printed.

Printing an Individual Topic

An individual topic can be printed while it displays on the right side of the screen by performing the following:

1. Right click the right side of the screen while the desired page displays. Select Print from the pop-up menu:

2. Select Pages: "1":

3. Click the Options tab at the top of the dialog box, and the Options dialog box displays:

4. Select "Only the selected frame", and make sure that the circle is blank next to "Print all linked documents". Click the Print button, and the displayed topic prints.

To print all of the topics that are linked to the displayed page, click the check box next to "Print all linked documents".

Printing the Entire MultiPlatform User's Guide

The entire MultiPlatform User's Guide can be printed by performing the following:

1. Click the "+" next to the first chapter to reveal it's subtopics.

2. Right click the left side of the screen, and select Print from the pop-up menu:

3. The Print dialog box displays. Under Page Range, select "All":

4. Click the Options tab at the top of the dialog box, and the Options dialog box displays:

5. Under Print Frames, select "All frames individually", and click the check box next to "Print all linked documents". Click the Print button, and all of the topics print.

No Options Tab in Printer Dialog Box

If the Print dialog box for your printer does not contain an Options tab, then those options are included in the Print dialog box. Set the options as described above.

Individual Topic Entire Guide

Using the MultiPlatform Help Systems - Interactive Wizards

InstallShield MultiPlatform includes two interactive wizards to assist new users of MultiPlatform in the creation of a project, and to provide all users with a means of creating a new project quickly and accurately:

● Quick-Start Wizard - Assists in the creation of a new project:

● Project Wizard - Assists in the modification of an existing project:

These wizards ask a series of questions and, based upon the answers you provide, create a new project or modify an existing one, directly in the IDE.

Using the MultiPlatform Help Systems - Context-sensitive/Bean Help

While working on a project in the IDE, clicking a bean in the left panel displays its help information in the right panel. This context-sensitive help is also referred to as "Bean Help":

Help information is also available for each of the properties of the selected bean. They are accessed via the links at the bottom of the Bean Help, each of which displays helpful information about the available settings for that property:

Each property's Bean Help includes its property name in parentheses, for use in creating custom beans (not available in MultiPlatform Lite).

The "Bean Help" link at the top returns to the context-sensitive/bean help for that bean. In the example above, clicking the "Bean Help" link returns to the "Product Component" Bean Help.

Help with Inserting a Bean

When a bean is highlighted in the Insert ... dialog box (after clicking or right-clicking a

bean and selecting "Insert ..." from the popup menu), a description of the selected bean displays:

Using the MultiPlatform Help Systems - APIs

InstallShield MultiPlatform includes extensively documented APIs, which are available to developers for simplification of creating custom beans, improved evolution strategy for bean data definitions, and improved access to core wizard APIs.

Accessing the API Documentation

There are two ways to access the MultiPlatform API documentation: In the IDE, and using an external browser.

1. In the IDE, click the Help link in the far left panel of the IDE, then click API. The API documentation opens in the IDE:

2. To view the APIs with an external browser, double-click the "index.html" file in the "help/ismp/api" directory under the directory where MultiPlatform is installed. The API documentation opens in your default browser, enabling the viewing of the API documentation while working on a project that is open in the IDE.

Viewing an API

Two tables of contents display in the center panel, and the API packages display in the right panel of the IDE or browser. All of the information contained in the API help is alphabetical. The top contents contains a list of all of the classes, the bottom contains a list of all of the APIs. A specific API can be selected by class, package, or from the alphabetical list.

The selected API documentation displays in the right panel, which can be viewed full-screen, or with the contents panes intact.

By Class

To view the list of APIs for a specific class, select that class from the top contents list, and the APIs within that class display in the bottom contents list:

By Package

To view a list of the APIs within a specific package, select that package from the list in the right panel. The list of the selected package's APIs displays in the right panel:

From the Alphabetical List

A specific API can be selected from the bottom contents list, either after selecting a class, or by scrolling through the alphabetical list and clicking its link. The selected API documentation displays in the right panel:

Full Screen

To view a selected API's documentation full-screen, click the "No Frames" link at the top, right corner of the API document. The contents pane disappears, spreading the documentation across the entire screen.

The viewing portion of the IDE can be made larger by clicking and dragging the left border as far is it will go to the left.

To return to the "frames" view, which redisplays the contents lists in the center panel, click the "Frames" link at the top, right corner of the API document.

Using the MultiPlatform Help Systems - Sample Bean Code

InstallShield MultiPlatform includes samples of bean code for the most frequently requested beans. These samples are located in the "samples" directory under the directory where MultiPlatform is installed:

Additional frequently used custom bean code is also available from our Web Site at http://www.installshield.com/support.

The .java files that are included with MultiPlatform are first grouped by Product and Wizard, then by function:

● The "infos" beans are in the "samples/com/installshield/isje/product/infos" and "/samples/com/installshield/isje/wizard/infos" directories.

● Product Action beans are in the "samples/product/actions" directory. ● Product Condition beans are in the "samples/product/conditions" directory. ● Product Wizard beans are in the "samples/product/wizardbeans" directory. ● Wizard Action beans are in the "samples/wizardx/actions" directory. ● Wizard Condition beans are in the "samples/wizardx/conditions" directory. ● Wizard Panel beans are in the "samples/wizardx/panels" directory.

Open the .java file using a text editor, and "Save As" a different file name so as not to modify the samples

that are included with MultiPlatform. Then, modify the bean as you require. For details about each of these samples, see Custom Bean Code Examples.

Using the MultiPlatform Help Systems - Platform Help

Specific Platform Pack (PPK) information for creating platform-specific installations is accessed by clicking Platform Help in the left panel of the IDE:

The left panel of the IDE expands to list all of the platforms included with InstallShield MultiPlatform. The AIX Platform is preselected because it is listed first, and its Contents display in the center panel, and its Overview page (the first topic) displays in the right panel of the IDE:

To select the Help for a different platform pack, click its link in the left panel of the IDE.

Using the MultiPlatform Help Systems - Tutorials

InstallShield MultiPlatform includes several tutorials for building projects, creating custom beans, and using command line options and XSL. These tutorials provide step-by-step instructions and give examples of specific functions.

A PDF of these tutorials and the Sample Project are available for downloading from our Web Site at http://www.installshield.com.

The following are the MultiPlatform User's Guide Tutorials, by category:

● Installations (Wizard) ❍ Creating a Simple Installer - Step-by-step instructions for creating a Simple installation type, which includes all of the required beans for a simple

installation with minimal end user input. ❍ Creating a Typical Installer - Step-by-step instructions for creating a Typical installation type, which includes a Setup Type Panel and sequences by

which the end user selects which feature(s) to install. ❍ Creating a Suite Installer - Step-by-step instructions for creating a Single-installer Suite, which installs two or more MultiPlatform installations with

one installer. ❍ Creating a Configuration Wizard - Step-by-step instructions for creating an "empty" wizard, which can perform, for example, ASCII and binary file

updates on the target machine without actually installing a product.

● Developer: Creating Custom Beans - Step-by-step instructions for creating a custom bean using the MultiPlatform open API. ❍ Custom Product Action ❍ Custom Product Bean Condition ❍ Custom Service ❍ Custom Wizard Action ❍ Custom Wizard Bean Condition ❍ Custom Wizard Panel

● Advanced: Command Line Usage & XSL ❍ Building a Project From the Command Line - Step-by-step instructions for building a project using a command line command(s) rather than opening

the IDE. ❍ Running a Wizard in Console Mode - Step-by-step instructions for running an installation where all messages and text is sent directly to the console

or command line window. ❍ Using Command Line Options - A list of all of the available options when building or running an installation in console mode. ❍ Using XSL Stylesheets - How to use XSLT (XSL Templates) to make changes to an installation project before building.

● Sample Project

Accessing the Tutorials

The Tutorials can be accessed by clicking the Tutorials link in the viewbar:

They can also be accessed from the MultiPlatform User's Guide Contents, both in the IDE and while using an external browser:

IDE Browser

The Tutorials can also be printed when viewed with an external browser, or from the PDF after downloading them from our Web Site (http://www.installshield.com). Follow the instructions for printing the MultiPlatform User's Guide, but open the Tutorials topic instead of Chapter 1 before printing.

Sample Project

In addition to the tutorials described above, MultiPlatform also includes a more technical project, the Sample Project, that targets four platforms and includes a resource bundle.

Using the MultiPlatform Help Systems - Conversion of InstallShield Java Edition (ISJE) 3.x to MultiPlatform 4.+

Projects that were built using InstallShield Java Edition (ISJE) 3.x can be converted to MultiPlatform 4.+/5.+. The MultiPlatform User's Guide provides Conversion instructions, and this information can also be accessed by clicking Conversion in the left panel of the IDE:

1.2 Interactive Project Wizards

InstallShield MultiPlatform provides interactive wizards for assisting developers in building and modifying projects. Unlike the Tutorials, the Quick Start and Project Wizards ask a series of questions and, based on your answers, create a new or edit an existing project directly in the IDE.

There are two kinds of wizards:

● Quick Start Wizard - Steps you through the creation of a new project. ● Project Wizards - Step you through the editing of a specific property in an existing project.

Accessing the Quick Start Wizard

To access the Quick Start Wizard, perform the following:

1. From the MultiPlatform menu in the left panel of the IDE, select Create New Project:

OR

Click the New Project icon at the top, left of the IDE:

2. The New Project page displays. Select the type of project you want to create:

3. A description of the type of project you selected displays. Read the description, then click Create:

4. The New Project dialog box displays. To use the interactive Quick Start Wizard, leave the check mark in the box next to Configure with wizard:

In the New Project dialog box, type a name for the project and its location, then click OK.

5. A message displays advising that the type of project you selected is being built:

6. The Quick Start Wizard begins with the introductory information. Read the information, then click Next.

7. The Quick Start Wizard steps you through the creation of the new project.

Accessing the Project Wizards

To access the Project Wizards, perform the following:

1. Open a project in the IDE.

2. Click the Project drop-down menu at the top, left of the IDE, and select Project Wizards:

3. The Project Wizards dialog box displays. Select the type of project wizard you want to run.

4. The Wizard starts by displaying the introductory information for the type of Project Wizard you selected. Read the information, then click Next.

5. The Project Wizard steps you through the modification of the project.

1.3 The MultiPlatform Graphical User Interface (GUI)

The MultiPlatform Graphical User Interface (GUI) provides several ways to build and edit your projects. MultiPlatform provides the following GUI items:

● Menus ● Toolbars ● Pop-up Menus

Menus

The menus display in the left panel of the IDE, and consist of the Main Menu, Project Menu, Help Menu, which includes API help, and Platform Help.

Main Menu

The Main Menu displays when MultiPlatform is first opened, and provides access to the following:

● Creating new and editing existing projects ● Help topics, including API help ● Platform Help ● The ability to convert InstallShield Java 3.x projects to InstallShield

MultiPlatform 4.0+

Project Menu

The Project Menu provides access to existing projects, and in the center panel of the IDE, displays the 3 types of new projects that can be created in MultiPlatform.

MultiPlatform Help Menu

The MultiPlatform Help menu provides access to the following:

● User's Guide - View the MultiPlatform User's Guide, and access its information from the Contents, Index, and Search functions that display in the center panel of the IDE. The selected topic's information displays in the right panel of the IDE.

● Product Tour - View a brief tour of how to use InstallShield MultiPlatform.

● What's New - View a brief description of the features and functions that are new in this release of MultiPlatform.

● API - View the APIs included with MultiPlatform. Select from the list in the center panel of the IDE, and their Javadoc information displays in the right panel.

● Platform Help - Access specific information for each platform that is supported by MultiPlatform.

Platform Help

The Platform Help link provides access to the information regarding each of the platform packs included with MultiPlatform. Access this information by clicking on the platform pack in the menu, or selecting the platform pack from the Contents list in the center panel of the IDE. The Platform-specific information for the selected Platform displays in the right panel of the IDE.

Toolbars

There are two types of toolbars in MultiPlatform: The one that displays at the top of the IDE at all times, and the tab-specific toolbars.

IDE Toolbar

This toolbar displays at the top of the IDE at all times. From this toolbar's buttons, the following actions can be performed (from left to right):

● Create a new project ● Open an existing project ● Save all changes made to the currently selected item in the tree ● Save the entire project ● Cut a bean ● Copy a bean ● Paste a bean ● Delete a bean ● Build the project ● Run the built project ● Open the MultiPlatform User's Guide in a separate IDE

Product Tab Toolbar

From this toolbar, the following actions can be performed (from left to right):

● Insert a bean above the selected bean ● Move a bean up in the sequence ● Move a bean down in the sequence ● View the component build/install order

Installer, and Uninstaller Tabs Toolbar


● Insert a bean above the selected bean ● Move a bean up in the sequence ● Move a bean down in the sequence

Build Tab Toolbar


● Build the project ● Add a new build configuration

Pop-up menus

Right-click a bean to display its pop-up menu. The pop-up menu contains the same functions as the toolbar for the tab that is currently viewed. Not all beans have a pop-up menu.

Product View Installer/Uninstaller View

1.4 The MultiPlatform Interface

The InstallShield MultiPlatform interface, or "builder," consists of three primary tabs/views: Product, Installer, Uninstaller, and Build. (The Installer and Uninstaller views are also referred to as "Wizards".)

Below is a typical view of the InstallShield MultiPlatform Integrated Development Environment (IDE):

The MultiPlatform interface is used to create, edit, and build projects, also called "installer archives".

For more information on the separate views, see the following topics:

● Using the MultiPlatform GUI ● The Product Tab/View ● The Installer Tab/View ● The Uninstaller Tab/View ● Wizards - Installer & Uninstaller Tabs/Views ● The Build Tab/View

1.5 Understanding Projects

The centerpiece of InstallShield MultiPlatform's IDE is the Project. Projects are documents that contain developer-specified information used to build installation products. InstallShield MultiPlatform Projects are:

● Stored in XML -- A human readable, structured file format. ● Defined by various project types that contain sections appropriate for the targeted wizard

application. ● Used to build InstallShield MultiPlatform Wizards.

XML File Format

An important feature introduced in MultiPlatform Version 4.0 is the use of XML to define all InstallShield MultiPlatform projects. XML, or eXtensible Markup Language, is a structured data format. XML serves several important roles for MultiPlatform developers:

● XML is human-readable, allowing developers to use standard text editors to open and review project contents.

● XML can be easily read and written by external applications, allowing for highly automated wizard development environments.

● Project contents can be migrated from earlier versions of InstallShield MultiPlatform without the loss of data.

Project Types

All InstallShield MultiPlatform projects are derived from specific project types. When you create a project, you specify the type of project to create. Each project type has different characteristics such as

● the number and type of project sections available to edit, ● the initial configuration of project sections and property values, and ● the validation performed on data during build operations.

There are four types of projects:

● Empty Wizard ● Simple & Typical Installers ● Suite Installations

Empty Wizard

The Empty Wizard, (also known as a Configuration Wizard), contains only two sections, also called "Views":

● Wizard ● Build

Configuration wizards are general purpose wizards that do not require additional data structures such as Product definitions and Uninstall wizards.

Simple & Typical Installation Views

In contrast to the Configuration Wizard, Product Installations called "Simple" and "Typical" contain the following four views:

● Product ● Installer ● Uninstaller ● Build

These four views are required to create a complete single product installation.

Multi- and Single-installer Suite Installations

In MultiPlatform and MultiPlatform with iSeries/CIM pack (not available in MultiPlatform Lite), there are two types of Suite Installations. The Multi-installer Suite consists of the following three views:

● Suite ● Installer ● Build

A Multi-installer Suite "wraps" several projects that were built with MultiPlatform into one installation experience for the end user. The combining of these pre-built projects occurs at runtime. Because these product installation project types serve different purposes, they require these additional structures.

The Single-installer Suite consists of the same views as Simple and Typical installations.

A Single-installer Suite also combines previously built MultiPlatform projects into one installation, but combines them at build time. This enables MultiPlatform to utilize Media Spanning, which "spans" the installation project over more than one CD, zip drive, etc., if required, based on the size of the project.

Building Projects

InstallShield MultiPlatform projects are configured using the MultiPlatform Integrated Development Environment (IDE). Once configured, these projects can be built to create installation and uninstallation wizards and wizard distributions.

During the build operations, a series of validations are performed on project data. Improper property values or other project settings can result in warning or error messages during the build. These error messages display in the Build Output view at the bottom of the IDE, and are also logged so they can be used for debugging purposes.

If a project builds successfully, you are notified with the appropriate messages in the Build Output view. You can then test and distribute the build.

See Also

● Creating a New Project ● Opening & Editing an Existing Project ● Migrating InstallShield Java Edition 3.x Projects to 4.x ● Configuring Project Properties ● Saving a Project ● Building a Project

Configuring Project Properties

To configure the properties of a project, perform the following:

When saving a project using Save As, the original project remains displayed/opened in the IDE. In order to edit the new project file, you must open it, then change the project properties as described below to change the new project's display name.

1. Click the Project drop-down menu at the top, left of the IDE, and select Properties:

2. The Project Properties dialog box displays:

3. In this dialog box, the following properties can be set: ❍ Name of the Project ❍ Location of the project or its creator ❍ The creator of the project's name and their email address ❍ The company for which the project is being created ❍ Comments

4. When finished, click OK.

Remarks

The date and time that this project was last saved automatically displays at the bottom of the dialog box.

Products

Javadoc API: "help/ismp/api/com/installshield/product/Product.html" (API not available in Lite.)

The Product bean is the overall bean for the installation project. It contains the following three levels:

● Product - Contains one or more Features ● Features - Contain one or more Components, and/or nested Features ● Components - Contain the actual data that will be installed on and any actions that will change the

target system

A Product's properties display when you select the Product bean in the Product Tab. These properties relate to the entire application (Product) that will be installed on the target machine.

There are Standard and Advanced properties for this type of bean. Below is a description of each property, along with its available options.

Standard Properties

Name Description

Condition(s) Add a File System, Locale, Platform, String Comparison, or custom condition to evaluate at runtime.

Bean ID A unique identifier for the bean. Unless you need to reference a bean by its Bean ID property, you do not need to change it. If you do change the Bean ID, select an ID that uniquely and meaningfully identifies the bean.

Use the following guidelines for Bean ID values:

● Names should be short and meaningful. ● Avoid the use of spaces.

Active Determines the state of the product at runtime. If "False", the product is not installed. In most cases, this value should not be changed.

Display Name The Display Name is used when the product is referenced in a message to the end user.

Name

Change this optional property to specify a non-localized identifier for a software object. Name is intended for inventory display and should not be localized. In contrast, the Display Name property for all product and wizard beans is intended for user messages and, typically, is localized.

Do not include a vertical bar (i.e., the pipe character "|") in this property because pipe characters are used as delimiters in the software registry file created by MultiPlatform.

DescriptionSpecifies a description for this product. This value appears in the Product Selection Panel used in suite installations. For all other installations, it does not display.

Install Location The default installation location, which is the absoluteInstallLocation() property. If this property is left blank, its value is assumed to be the Install Location of its parent. Since the Product has no "parent", the Install Location defaults to the current working directory because that is what an empty file path in Java defaults to. This includes, for example, a "temp" file(s) if the installer is wrapped in "setup.exe".

InstallShield recommends that an absolute path not be used for this property when multiple platforms are targeted due to the differences in the way an absolute path is resolved on different platforms. For example: "/mydirectory" on UNIX systems resolves to "/mydirectory", and on Windows systems to "C:\mydirectory".

If an absolute path is used, it is recommended that the forward slash character ('/') be used, which is resolved to the current platform's separator character at runtime.

This property supports global string resolution, such as "$D(install)/myapps/appA", which is a convenient way to specify a Named Directory for this property. Named Directories are identifiers that resolve to the specific directories for each platform. To include a named directory for the Install Location property, use the following notation:

$D(directoryName)

where directoryName is one of the following named directories:

install The default installation directory.

lib The system shared library directory.

temp The system temporary directory.

log The system log directory.

home The current user's home directory.

Examples

"$D(install)/ACME Software/Killer App 1.0""$D(lib)""$D(home)/acme_config"

Replace Option When a file(s) is installed more than once to the same Install Location, when another product is installed that includes files that were previously installed by another product to the same Install Location, or an "update" or "patch" is installed to this product, this property value determines whether the product replaces the existing file(s). Set this option to one of the choices below:

● "Default" = Replace if Newer; Prompt if Older ● "Always Replace" ● "Never Replace" ● "Replace if Newer" ● "Prompt if Older" ● "Always Prompt"

Remove Option During uninstallation, the Product must determine whether to reverse the changes that were made during installation. For example, the Product must decide whether to delete the files that it added. Set this option to one of the choices below:

● "Default" - Remove if Unmodified; Prompt if Modified ● "Always Remove" ● "Never Remove" ● "Remove if Unmodified" ● "Prompt if Modified" ● "Always Prompt"

Advanced Properties

Name Description

Key Unique product key identifiers. See Software Object Key Properties for specific instructions in setting this property.

Publicly Sharable Specifies whether this product can be available to other installation projects such as a Multi-installer or Single-installer suite. Options are "True" or "False".

Required Specifies the internal and/or external software objects required by this product for a successful installation. Internal requirements are features and/or components within this installation. External requirements are other products. To specify the requirements, perform the following:

1. Click in the Required field, and click the ellipsis (...). 2. In the Required Software Objects window, click either Add

Internal or Add External. 3. If you chose to add an internal requirement, select the component

or feature from the displayed product tree, and click OK. 4. If you chose to add an external requirement, complete the fields in

the Externally Required Component window that reflect the UID and Key/Version information for the required product.

5. Click OK. 6. Click OK.

Product Number A unique identifier for the product being installed. This field is primarily informational.

Vendor The name of the vendor of the product. This name displays on the Welcome Panel.

Vendor Web site The URL for your company or the product. This information displays in the Welcome Panel.

Locale A locale for the product. If you set a locale, the product is installed only if the specified locale is selected for the installation by the end user via a Locale Panel, or if no Locale Panel is included with the project.

Patch If set to "True", then this Product is treated as a "patch" installation, ie., it cannot be installed except over a previous install of the same Product (that was originally built by MultiPlatform). The default setting for this property is "False".

See Also

● Features ● Nested Features ● Components ● Advanced Installs: Updates and Patches

Features

Javadoc API - "help/ismp/api/com/installshield/product/ProductFeature.html" (API not available in Lite.)

A Product Feature represents the smallest piece of an installation from the end user's perspective, and is a major element of the application. A Feature is made up of one or more Component(s), which contain the actual data, e.g., executables, files, desktop icons, etc., that will be installed on the target machine. A Feature bean is used to group together all of the Components that are required for that Feature.

A Feature's properties display when you select the Feature bean in the Product tree. These properties relate to the entire Feature that will be installed on the target machine.

A feature's name, as it will appear in a Setup Type Panel, can be changed in the Product Tree by clicking it once and typing the new name.

Standard Properties

Once a Feature has been added to the Product tree, its properties can be set. There are Standard and Advanced properties for this type of bean. Below is a description of each property, along with instructions for how it should be set.

Name Description


All Conditions on Product beans are evaluated at the start of the Install Action.

Bean ID A unique identifier for the bean.

Active Determines the state of the feature at runtime. If "False", the feature is not installed. The default is "True" and, in most cases, should not be changed.

If a Setup Type does not contain any features, and it is the type entered as the Setup Type property for the Setup Type Sequence bean, then the user will be able to select any and all of the features whose Active property is "True".

Display Name

This property is used when the feature is referenced in a message to the end user, e.g., when displayed on a Feature Panel.

Name Change this optional property to specify a non-localized identifier for the software object. It is intended for inventory display only and should not be localized. In contrast, the Display Name property (above) for all product and wizard beans is intended for user messages, and is typically localized.


Description Specifies a description for this feature, and is used for administrative purposes only.

The following is where to change the actual title that displays on the wizard panels:

● Installation wizards - Installer Tab, Setup Properties ● Uninstallation wizards - Uninstaller Tab, Uninstall Properties

Install Location

The installation location for the feature. If this field is left blank, it defaults to the Install Location of the Product unless it is a nested feature - Then its value is assumed to be the Install Location of its parent feature.


$D(directoryName)







Examples


Replace Option

When a file(s) is installed more than once to the same Install Location, when another product is installed that includes files that were previously installed by another product to the same Install Location, or an "update" or "patch" is installed to a product, this property value determines whether the feature replaces the existing file(s). Set this option to one of the choices below:

● "Default" = Inherits the value of the Replace Option property of the parent Feature or Product

● "Always Replace" ● "Never Replace" ● "Replace if Newer" ● "Prompt if Older" ● "Always Prompt"

Remove Option

During uninstallation, product features must determine whether to reverse the changes that were made during their installation. For example, the feature must decide whether to delete the files that it added. Set this option to one of the choices below:

● "Default = Inherits the value of the Remove Option property of the parent Feature or Product

● "Always Remove" ● "Never Remove" ● "Remove if Unmodified" ● "Prompt if Modified" ● "Always Prompt"

Visible This property determines whether this feature displays to the end user on the Feature and Summary Panels during installation. It has the same effect on the feature on the Uninstall Feature and post-install Summary Panels (in the Uninstaller Wizard Tree) during uninstallation. The default value is "True".

If there is no Feature and/or Summary Panel in the Installer Wizard Tree, then this property is ignored. This property does not affect whether a feature is installed.

● Set this property to "True" to display this feature in the Feature and Summary Panels during installation and uninstallation. If this is a nested feature, then all of its parent features must also have their Visible property set to "True". For example, in the scenario below, Nested Feature 3 (and, of course, Nested Feature 2) will not display on the Feature or Summary Panels:

Feature 1 - Visible = "True" Nested Feature 2 - Visible = "False" Nested Feature 3 - Visible = "True"

● Set this property to "False" if you do not want this feature or any of its nested features displayed on the Feature or Summary Panels during installation and uninstallation.

Advanced Properties

Name Description

Build Categories NEEDS DESCRIPTION

Key Unique product key identifier. See Software Object Key Properties for specific instructions in setting this property.


Required Software Objects Specifies the internal and/or external software objects required by this feature for a successful installation. Internal requirements are features and/or components within this installation. External requirements are other products. To specify the requirements, perform the following:






Product Number A unique identifier for the feature being installed. This field is primarily informational.

Vendor The name of the vendor of the feature. This name is displayed on the Welcome Panel.

Vendor Website The URL for your company or the feature. This is displayed in the Welcome Panel

locale, the feature is installed only if the specified locale is selected for the installation. A Predefined or Custom locale can be assigned to the feature.

See Also

● Products ● Components ● Language Support

Feature Nesting

Feature "nesting" provides the ability to insert a new feature bean within an existing feature in the Product Tree. This is helpful when developing an installation that includes subfeatures that are a part of a particular feature. Like any feature, a nested feature can be optional or required, and displays to the end user during installation/uninstallation on the Feature Panel/Uninstall Feature Panel for selection or deselection. The only difference is that it is a child of the Feature along with the Feature's components.

For example, an installation that includes an Online Help Feature (Feature 1) also includes an optional PDF version of the Online Help, and an interactive Tutorial, which are optional features. In order to give the end user a choice of one or both of these additional Help features, we need each as a nested feature of Feature 1:

The example above could not have been accomplished with separate components within Feature 1 because component objects are never seen by the end user.

If a nested feature's parent feature's Visible property is "False", then the nested feature will not display on the Feature or Summary Panels during installation or uninstallation regardless of this nested feature's Visible property setting.

Adding a Nested Feature

To add a feature under an existing feature, perform the following:

1. In the Product Tab, right-click the feature within which you want to add another feature, and select Insert Feature from the pop-up menu:

OR

Click the feature, then click (Insert button), and select Insert Feature.

2. The new feature appears as a child of the selected feature in the Product Tree, and is automatically given the next sequential feature number:

If the nested feature's Required property is "None", then the user will have the ability to select or deselect it on the Feature or Uninstall Feature Panels. If any other object requires this feature, then it displays as permanently "selected", and the end user is not able to deselect it.

See Also

● Required Software Objects ● Feature Object ● Component Object

Components

Javadoc API - "help/ismp/api/com/installshield/product/ProductComponent.html" (API not available in Lite.)

A Feature's Component(s) is the basic building block of a Product's definition because it directly contains the data to be installed on the target system, e.g., files, desktop icons, and the product action(s) that needs to take place during the feature's or product's installation, e.g., environment variable updates, ascii file updates, etc. Components do not display to the end user.

Standard Properties

Once a Component has been added, its properties can be set. These properties relate to the Component's

elements that will be installed on the target machine. There are Standard and Advanced properties for this type of bean. Below is a description of each property, along with instructions for how it should be set.

Name Description


All Conditions on Product beans are evaluated at the start of the Install Action.

Bean ID A unique identifier for the bean.

Active Determines the state of the component at runtime. If "False", the component is not installed. The default is "True" and, in most cases, this value should not be changed.

Name Change this optional property to specify a non-localized identifier for this software object. Name is intended for inventory display, and should not be localized. Components do not have a Display Name property that can be set in the IDE because they do not display to the end user.


If you have a custom bean within which you want to display a name for the component (other than its name in the Product Tree), you can set it manually by setting the localizedDisplayName property for the component in the project's XML file. By doing that, for example, the getDisplayName() method of the ProductService will get the value of the localizedDisplayName property.

Description Specifies a description for this component, which is for the developer's administrative use only.

Install Location The installation location for the component. If this field is left blank, it defaults to the Install Location of its parent feature.


$D(directoryName)







Examples


Replace Option When a file(s) is installed more than once to the same Install Location, when another product is installed that includes files that were previously installed by another product to the same Install Location, or an "update" or "patch" is installed to a product, this property value determines whether the component replaces the existing file(s). Set this option to one of the choices below:

● "Default" = Inherits the value of the Replace Option property of the parent Feature or Product

● "Always Replace" ● "Never Replace" ● "Replace if Newer" ● "Prompt if Older" ● "Always Prompt"

Remove Option During uninstallation, components must determine whether to reverse the changes that were made during installation. For example, the component must decide whether to delete the files that it added. Set this option to one of the following choices:

● "Default"= = Inherits the value of the Remove Option property of the parent Component, Feature, or Product

● "Always Remove" ● "Never Remove" ● "Remove if Unmodified" ● "Prompt if Modified" ● "Always Prompt"

Install Failure Option If a failure occurs during installation, this property determines the appropriate action. The options are as follows:

● "Continue" - Install process moves to next bean ● "Cancel" - Install process stops at this point) ● "Cancel and Rollback" - Install process stops after all install actions

have been reversed

On Fail Summary Message

The message that displays to the end user and is logged in the log file if the installation of the component fails. A localized string resolver method can be used for this property.

Advanced Properties

Name Description

Key Unique product key identifier. See Software Object Key Properties for specific instructions on setting this property.


Required Specifies the internal and/or external software objects required by this component for a successful installation. Internal requirements are features and/or components within this installation. External requirements are other products. To specify the requirements, perform the following:






Product Number A unique identifier for the product being installed. This field is primarily informational.

Vendor The name of the vendor of the product. This name is displayed on the Welcome Panel, and is optional.

Vendor Website The URL for your company or the product. This is displayed in the Welcome Panel, and is optional.

Locale A locale for the component, which indicates which language should be displayed to the user.

See Also

● Features ● Products ● Language Support

Extended Platform Properties

Most of the properties configured for different beans are considered either "core" or "advanced" properties. These properties are useful to multiple platforms. Occasionally, however, a platform pack needs to gather additional information to utilize a particular bean. These are referred to as "Extended" properties, and they are added by the individual platform packs.

Viewing a Bean's Extended Platform Properties

To only view these properties, click the plus ("+") box next to the Platform Pack in the center panel of the IDE, and its extended properties display. These properties cannot be edited unless the Include check-box has been selected, as described below.

Editing a Bean's Extended Platform Properties

To edit a bean's extended properties for a particular platform pack, you must click the Include check-box next to the Platform. The properties for that platform display in the center panel of the IDE. These properties can now be edited.

Standard properties are overridden by those same Platform-specific properties when the target system matches the specified platform.

With MultiPlatform releases before Release 4.5 (incl. SP3+), if Linux is a targeted platform, then a Linux RPM Check Install Panel must be added to the Installer and Uninstaller trees before the Install and Uninstall action beans.

See Also

● Understanding Beans ● Editing Bean Properties

file:///Y|/Help%20Stuff/HTMLs%204%20PDF/Topics/understanding_beans.htm

Replace Option and Install Location Properties

The Replace Option property for a Product, Feature, and Component determines the action that is taken by a new, "update", or "patch" installation when it finds a matching UID and Install Location for the object on the target machine.

Below are descriptions of and instructions for setting the properties for the Replace Option and Install Location properties.

Replace Option Property

The Replace Option property is a Standard property for Product, Component, and Feature software objects. It determines whether it is replaced automatically, replaced with user intervention, or not replaced at all.

Property Value Descriptions

The options for the Replace Option property are as follows:

"Default" The object inherits the Replace Option property value from its parent. If the object is the Product, then this value means "Replace if Newer; Prompt if Older" because the Product object has no "parent" from which to inherit this value.

"Always Replace" The original object is replaced with the object contained in the new, update, or patch installation

Date post:	05-Jul-2020
Category:	Documents
Upload:	others
View:	12 times
Download:	0 times

InstallShield MultiPlatform User's Guide · 2009-09-22 · What's New in InstallShield...

Documents