Open topic with navigation

ISWiSuitePackage Object (Advanced UI and Suite/Advanced UI)

InstallShield 2015 » Automation Interface » Advanced UI and Suite/Advanced UI

Project: This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition: The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project type is available in the Premier edition of InstallShield. For information about the differences between these two project types, see Advanced UI Projects vs. Suite/Advanced UI Projects.

The ISWiSuitePackage object represents a package or a Windows Installer transaction that is included in an Advanced UI or Suite/Advanced UI project.

To add or remove packages and transactions, call ISWiProject.AddSuitePackage or ISWiProject.DeleteSuitePackage.

Important: Note that some ISWiSuitePackage items are not applicable to all types of Advanced UI or Suite/Advanced UI package files. Use the PackageType property to determine the package type. If one of the other ISWiSuitePackage properties returns an empty value, that property is not applicable to that package type.

Also note that the Advanced UI project type, which is available in the Professional edition of InstallShield, does not have support for most of the types of package files; the only ones that it does support are .msi, msp, and InstallScript packages.

Members

ISWiSuitePackage Object Members

Name

Type

Type of Package File

Description

AddDetectCondition

Method

.msi,
.msp,
.exe,
.appx, InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

Adds a detection condition to a package in an Advanced UI or Suite/Advanced UI project.

AddEligibleCondition

Method

.msi,
.msp,
.exe,
.appx, InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

Adds an eligibility condition to a package in an Advanced UI or Suite/Advanced UI project.

AddSuitePackage

Method

.msi,
.msp

Project: This is available in Suite/Advanced UI projects.

Edition: The Suite/Advanced UI project type is available in the Premier edition of InstallShield.

Adds an .msi or .msp package to a Windows Installer transaction.

CachePath

Read-Write String Property

.msi,
.msp,
.exe,
.appx, InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

Gets or sets where the cached package and other package files should be stored on the end user’s system. You can enter a hard-coded value such as C:\CachedFiles, but it is recommended that you use a destination property for the path. The default value is as follows:

[LocalAppDataFolder]Downloaded Installations

The Setup.exe tab in the Releases view lets you specify whether you want to cache the packages on target systems for any packages that are run on target systems and that have a cache path defined. If you are building an uncompressed release, you may want to avoid caching packages on the target system.

The value of this property can include one or more formatted expressions that contain property names, environment variable references, and other special strings; at run time, the installation expands the values of these expressions. To learn about the syntax that is available for these expressions, see Using Formatted Expressions that Advanced UI and Suite/Advanced UI Installations Resolve at Run Time.

CerFile

Read-Write String Property

appx

Project: This is available in Suite/Advanced UI projects.

Edition: The Suite/Advanced UI project type is available in the Premier edition of InstallShield.

Gets or sets the .cer file that you are using in your sideloading package.

The versions of Windows that support .appx packages do not install a sideloading package unless they trust the source of the package. If you are using a custom certificate, such as the one that is generated in Visual Studio, the Suite/Advanced UI installation can make Windows trust the source of your package by adding the custom certificate to the certificate store of target systems.

DeleteCondition

Method

.msi,
.msp,
.exe,
.appx, InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

Removes a detection or eligibility condition from a package.

DetectCondition

Read-only Object Property

.msi,
.msp,
.exe,
.appx, InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

This property accesses the ISWiSuiteCondtion object.

Gets or sets the conditions that the Advanced UI or Suite/Advanced UI installation should use to evaluate whether the package is already installed on target systems.

DisplayName

Read-Write String Property

.msi,
.msp,
.exe,
.appx, InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

Gets or sets the name that is displayed for the package at run time.

DynamicParcelProductConfig

Read-Write String Property

Basic MSI project

Project: This is available in Suite/Advanced UI projects.

Edition: The Suite/Advanced UI project type is available in the Premier edition of InstallShield.

Gets or sets the path to the product configuration that contains the release in the InstallShield project that you want to associate with the selected package.

DynamicParcelRelease

Read-Write String Property

Basic MSI project,
InstallScript project

Project: This is available in Suite/Advanced UI projects.

Edition: The Suite/Advanced UI project type is available in the Premier edition of InstallShield.

Gets or sets the release in the InstallShield project that you want to associate with the selected package.

DynamicParcelSourcePath

Read-Write String Property

Basic MSI project,
InstallScript project

Project: This is available in Suite/Advanced UI projects.

Edition: The Suite/Advanced UI project type is available in the Premier edition of InstallShield.

Gets or sets the source path of the Basic MSI or InstallScript project (.ism) that you are including in the Suite/Advanced UI project.

Elevate

Read-Write Boolean Property

.msi,
.msp,
.exe,
InstallScript,
Web Deploy,
Basic MSI project, InstallScript project

Gets or sets the value of the Require Elevated Privileges setting in the Packages view. This setting indicates whether the package requires elevation on Windows Vista and later and Windows Server 2008 and later systems.

EligibleCondition

Read-only Object Property

.msi,
.msp,
.exe,
.appx, InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

This property accesses the ISWiSuiteCondtion object.

Gets or sets the conditions that the Advanced UI or Suite/Advanced UI installation should use to determine whether the target system meets the requirements that are necessary for the package to be run.

IsPrimary

Read-Write Boolean Property

.msi,
.msp,
.exe,
.appx, InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

Project: In Suite/Advanced UI projects, this property is available for edit. In Advanced UI projects, this setting is read-only, since an Advanced UI project has support for only one primary package.

Gets or sets the Package Type setting for a package in the Packages view. This setting identifies whether the presence of this package on the target system should influence whether the Suite/Advanced UI installation runs in first-time-installation mode or maintenance mode.

Available options for this property are:

• True—The selected package is a primary package; that is, a main part of the Advanced UI or Suite/Advanced UI installation.

At run time, if all of the primary packages in the installation are absent from the target system, the installation runs as a first-time installation. If any of the primary packages are present on the target system, the installation runs in maintenance mode.

• False—The selected package is a dependency package; that is, it should not be a factor in determining which mode is used to run the Advanced UI or Suite/Advanced UI installation.

ISWiSuiteActionRefs

Collection

.msi,
.msp,
.exe,
.appx,
InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

Project: This is available in Suite/Advanced UI projects.

Edition: The Suite/Advanced UI project type is available in the Premier edition of InstallShield.

Contains all of the Suite/Advanced UI actions that are scheduled for a specific package event.

ISWiSuiteEvents

Collection

.msi,
.msp,
.exe,
.appx,
InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

Project: This is available in Suite/Advanced UI projects.

Edition: The Suite/Advanced UI project type is available in the Premier edition of InstallShield.

Contains all of the events that are associated with a package in a project.

ISWiSuiteFolders

Collection

.msi,
.msp,
.exe,
.appx,
InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

Contains every folder in a package of your project.

ISWiSuitePackages

Collection

transaction

Contains every package (as an ISWiSuitePackage object) in a Windows Installer transaction.

LoggingCmdLine

Read-Write String Property

.exe,
InstallScript,
InstallScript project

This property is available if the value of the LoggingEnable property is True.

Gets or sets the value of the Logging Command Line setting in the Packages view. This setting indicates the command line that the Advanced UI or Suite/Advanced UI installation should pass to the .exe package to enable the logging. Include any appropriate supported flags. If the .exe package that you are configuring supports it, include a path that references the Advanced UI or Suite/Advanced UI property ISLogDir, enclosed within square brackets, in place of the path to the directory where the log file should be created.

For example, to generate a log file that logs everything verbosely for an .msi package that is run by a Setup.exe file that InstallShield built, enter the following command line:

/v"/l*v \"[ISLogDir]FileName.log\""

The Advanced UI or Suite/Advanced UI installation replaces [ISLogDir] with the path to the folder that will contain the log file. The Advanced UI or Suite/Advanced UI /log command-line parameter lets end users specify the path to the directory for the package log files.

For more information, see Supporting the Creation of Package Log Files for Command-Line Launching of an Advanced UI or Suite/Advanced UI Installation.

LoggingEnable

Read-Write Boolean Property

.msi,
.msp,
.exe,
InstallScript,
Basic MSI project,
InstallScript project

Gets or sets the Enable Logging Support setting in the Packages view. This setting indicates whether you want the package to generate a log file if the Advanced UI or Suite/Advanced UI installation is launched from the command line with the /log command-line parameter. Note that if a package does not have support for logging, it is recommended that you do not enable logging support for that package.

If you select Yes, configure the other logging-related properties as needed.

For more information, see Supporting the Creation of Package Log Files for Command-Line Launching of an Advanced UI or Suite/Advanced UI Installation.

LoggingMsiLogFile

Read-Write String Property

.msi,
.msp,
Basic MSI project

This property is available if the value of the LoggingEnable property is True.

Gets or sets the value of the Logging Command Line setting in the Packages view. This setting indicates a name for the log file. Do not include a path for the file; the Advanced UI or Suite/Advanced UI /log command-line parameter lets end users specify the directory for the package log files.

If you leave this setting blank, the name of the log file that the installation creates is PackageGUID.log, where PackageGUID is the GUID that is assigned to the package in the Package GUID setting in the Packages view.

For more information, see Supporting the Creation of Package Log Files for Command-Line Launching of an Advanced UI or Suite/Advanced UI Installation.

LoggingMsiLogOptions

Read-Write String Property

.msi,
.msp,
Basic MSI project

This property is available if the value of the LoggingEnable property is True.

Gets or sets the value of the Log Options setting in the Packages view. This setting indicates the Windows Installer log /L flags that you want the package to use when generating the log file. For example, to generate a log file that logs everything verbosely, enter the following in this setting:

*v

For additional valid flags, see the /L description.

If you leave this setting blank, the asterisk (*) and v flags are used to generate the log file.

For more information, see Supporting the Creation of Package Log Files for Command-Line Launching of an Advanced UI or Suite/Advanced UI Installation.

MoveDown

Method

.msi,
.msp,
.exe,
.appx,
InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project, transaction

If your project has more than one package or transaction, the Packages view lists them in the same order in which the Advanced UI or Suite/Advanced UI installation launches them at run time. The MoveDown method moves a package or transaction down in the ordered list, below the item that follows it.

MoveUp

Method

.msi,
.msp,
.exe,
.appx,
InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project, transaction

If your project has more than one package or transaction, the Packages view lists them in the same order in which the Advanced UI or Suite/Advanced UI installation launches them at run time. The MoveUp method moves a package or transaction up in the ordered list, above the item that precedes it.

Name

Read-Write String Property

.msi,
.msp,
.exe,
.appx, InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

Gets or sets the internal name of the package.

Operation

Read-only Object Property

Support varies

This property accesses the ISWiSuiteOperation object.

Gets the operation of the specified type. Available options are:

• esotInstall (1)—The package is launched as a first-time installation.

This operation is available for the following types of package files: .msi, .msp, .exe, .appx, InstallScript, Basic MSI project, and InstallScript project.

• esotRemove (2)—The product that the package installed is removed.

This operation is available for the following types of package files: .msi, .exe, .appx, InstallScript, Basic MSI project, and InstallScript project.

• esotRepair (3)—The product that the package installed is repaired.

This operation is available for the following types of package files: .msi, .exe, InstallScript, Basic MSI project, and InstallScript project.

• esotModify (4)—The package is launched in maintenance mode to enable end users to install, remove, or modify the product.

This operation is available for the following types of package files: .msi, .msp, .exe, InstallScript, Basic MSI project, and InstallScript project.

PackageLocation

Read-Write String Property

.msi,
.msp,
.exe,
.appx, InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

This property accesses the ISWiPackageLoc object.

Gets or sets where the package is configured to be located. Available options are:

• eplSourceMedia (0)—Copy from source media. That is, store the package and its files on the source media.

If the Advanced UI or Suite/Advanced UI installation will be run uncompressed from fixed media—such as CD, DVD, or local network—use this option.

• eplSetupExe (1)—Extract from Setup.exe. That is, compress the package and its files into Setup.exe, to be extracted at run time, if necessary.

If the entire Advanced UI or Suite/Advanced UI installation must be self-contained in Setup.exe, use this option. Note that the Web option results in smaller installations and shorter download time; however, the Setup.exe option provides for a completely self-contained installation.

• eplWeb (2)—Download from the Web. That is, download the package and its files (if necessary) from the URL that is specified for the package.

This option is recommended if your installation will be downloaded from the Internet and you want to minimize the Advanced UI or Suite/Advanced UI package size and download time. An Advanced UI or Suite/Advanced UI package is not downloaded if the correct version is already present on the target system.

Note that you can override this property for all packages when you are configuring a release.

PackageType

Read-only String Property

.msi,
.msp,
.exe,
.appx, InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

Gets the type of package in the project:

• esptTransaction (-1)—Windows Installer transaction
• esptMsi (1)—Windows Installer package (.msi)
• esptMsp (2)—Windows Installer patch (.msp)
• esptExe (3)—executable package (.exe)
• esptIsp (4)—InstallScript package
• esptIsmMsi (5)—Basic MSI project (.ism)
• esptIsmIsp (6)—InstallScript project (.ism)
• esptAppx (7)—Sideloading app package (.appx)
• esptWebDeploy (8)—Web Deploy package (.zip)

PackageURL

Read-Write String Property

.msi,
.msp,
.exe,
.appx, InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

Gets or sets the URL for the root folder that will contain the selected package and its folders and files. The package and any accompanying files are downloaded from this location to target systems at run time if the package needs to be launched.

This property is applicable if the value of the PackageLocation property is eplWeb (2).

ParcelType

Read-Write String Property

.msi,
.msp,
.exe,
.appx,
InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

Project: In Suite/Advanced UI projects, this property is available for edit. In Advanced UI projects, this property is read-only, since an Advanced UI project has support for only one primary package.

Gets the type of package that identifies whether the presence of this package on the target system should influence whether the Suite/Advanced UI installation runs in first-time-installation mode or maintenance mode.

Available options for this setting are:

• espltPrimary (0)—The selected package is a main part of the Advanced UI or Suite/Advanced UI installation.

At run time, if all of the primary packages in the installation are absent from the target system, the installation runs as a first-time installation. If any of the primary packages are present on the target system, the installation runs in maintenance mode.

• espltDependency (1)—The selected package should not be a factor in determining which mode is used to run the Advanced UI or Suite/Advanced UI installation.

For more information, see Primary Packages vs. Dependency Packages in Advanced UI and Suite/Advanced UI Projects.

ProgressCapture

Read-Write String Property

.msi,
.msp,
Basic MSI project

Gets or sets the value of the Status Messages Reporting setting in the Packages view. This setting indicates what sort of status messages are available for displaying in the user interface of the Advanced UI or Suite/Advanced UI installation. Available options are:

• epsptCaptureFull (3)—Action text. The Advanced UI or Suite/Advanced UI installation’s status messages include the action text from the standard actions and custom actions in the package.
• epsptCaptureFullVerbose (4)—Action text and action data. The Advanced UI or Suite/Advanced UI installation’s status messages include the action text as well as action data from the standard actions and custom actions in the package.

At run time, the Advanced UI or Suite/Advanced UI installation updates the ISParcelStatus property with the action text and, if applicable, the action data in the ISParcelStatus property, which is displayed on the InstallationProgress wizard page of the Advanced UI or Suite/Advanced UI installation by default.

For example, when the InstallFiles action in an .msi package is executing, the ISParcelStatus property is updated with the action text “Copying new files” to inform end users about the current progress of the installation. If you choose to include action data in the status messages, the ISParcelStatus property may also be updated with action data such as the name, directory, and size of each file as it is being installed on the target system.

ReleaseFlags

Read-Write String Property

.msi,
.msp,
.exe,
.appx,
InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

Gets or sets the release flags that are assigned to the package. Separate multiple flags with a comma.

You can use release flags to selectively include and exclude this package from different builds of your Advanced UI or Suite/Advanced UI installation.

RootFolder

Read-only Object Property

.msi,
.msp,
.exe,
.appx, InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

This property accesses the ISWiSuiteFolder object.

Gets the root folder that contains the package and its folders and files.

SharedParckage

Read-Write Boolean Property

.msi,
.msp,
.exe,
.appx, InstallScript,
Basic MSI project,
InstallScript project

Gets or sets the value for the Shared setting in the Packages view. This setting indicates whether the package is shared with other products and should be removed only if no other products that are left behind are using this package.

UpgradeType

Read-Write String Property

.msi,
Basic MSI project

Gets or sets the value of the Minor Upgrade Handling setting in the Packages view. This setting indicates the behavior that should occur when an earlier version of the package is present on the target system. Available options are:

• epsutNone (0)—None. The Advanced UI or Suite/Advanced UI installation launches the package without running it in minor upgrade mode. That is, the Advanced UI or Suite/Advanced UI installation does not set the REINSTALL or REINSTALLMODE properties for the package.
• epsutAuto (1)—Automatic. The Advanced UI or Suite/Advanced UI installation launches the package in upgrade mode by setting the REINSTALL property to ALL and the REINSTALLMODE property to vomus. It does not inform the end user that the product will be upgraded.
• epsutPrompt (2)—Ask the user. The Advanced UI or Suite/Advanced UI installation displays a secondary window that asks the end user whether they want to continue. If the end user chooses to continue, the Advanced UI or Suite/Advanced UI installation launches the package in upgrade mode. If the end user chooses to not continue, the package does not run.

WindowsFeatures

Read-Write String Property

.msi,
.msp,
.exe,
.appx,
InstallScript,
Web Deploy,
Basic MSI project,
InstallScript project

Project: This is available in Suite/Advanced UI projects.

Edition: The Suite/Advanced UI project type is available in the Premier edition of InstallShield.

Gets or sets a semicolon-delimited list of one or more Windows roles and features that the selected package requires be enabled on target systems that have Windows Vista or later or Windows Server 2008 or later.

The names of the roles and features should be the string that tools such as Deployment Image Servicing and Management (DISM.exe) and Package Manager (Pkgmgr.exe) use to identify the role or feature on a particular version of Windows. For a list of available Windows roles and features on each version of Windows for which you are supporting, see Microsoft TechNet.

At run time, if this package is eligible to be installed and it requires one or more Windows roles and features that are disabled, the Suite/Advanced UI installation enables them before launching the package.

For more information, see Enabling Windows Roles and Features During a Suite/Advanced UI Installation.

Example

The following VBScript lines demonstrate how to display information about a package in a project. Windows Installer transactions can contain multiple packages, so the script is implemented recursively.

Sub WritePackage(indent, p)

    If p.PackageType = -1 Then ' Transaction

        out.WriteLine indent & "Transaction:"

        For Each sp In p.ISWiSuitePackages

            WritePackage indent & " ", sp

        Next

    Else

        out.WriteLine indent & IDS(p.DisplayName) & " (" & p.Name & ")"

        out.WriteLine indent & "Type: " & p.PackageType

        out.WriteLine indent & "Description: " & p.Description

        out.WriteLine indent & "Shared: " & p.SharedPackage

        out.WriteLine indent & "Location: " & p.PackageLocation & " " & p.PackageUrl

        out.WriteLine indent & "Release Flags: " & p.ReleaseFlags

        out.WriteLine indent & "Files:"

        WriteFolder indent & " ", p.RootFolder

        out.WriteLine indent & "Detection Condition:"

        WriteCondition indent & " ", p.DetectCondition

        out.WriteLine indent & "Eligibility Condition:"

        WriteCondition indent & " ", p.EligibleCondition

    End If

End Sub

Applies To

• ISWiProject

InstallShield 2015 Help Library

June 2015

 Copyright Information | Contact Us