InstallShield 2019 » Releases View » Release
Project • The Events tab is available in the following project types:
• | Advanced UI |
• | Basic MSI |
• | InstallScript |
• | InstallScript MSI |
• | InstallScript Object |
• | Merge Module |
• | Suite/Advanced UI |
Additional project-specific differences are noted where applicable.
The Events tab lets you configure settings for various tasks that you want InstallShield to perform before, during, or after builds.
The Events tab settings are organized into the following main categories:
• | Commands |
• | Publishing |
• | Distribution |
• | Virtual Machine (This area is available in the Premier edition of InstallShield.) |
Use the Commands area on the Events tab to specify commands that you want to be run at various stages of the build process.
Setting |
Project Type |
Description |
Prebuild Event |
Basic MSI, InstallScript, InstallScript MSI, Merge Module, Suite/Advanced UI |
Edition • This setting is available in the Premier edition of InstallShield. Specify the command that you want to be run before InstallShield starts building the release. This event runs after InstallShield creates the release folder and log file, but before InstallShield starts building the release. To specify more than one command, click the ellipsis button (...) in this setting, which opens the Prebuild Event dialog box. Enter each command on a separate line in this dialog box. At build time, InstallShield runs each command in the order that they are listed. The build waits until a command finishes before proceeding to the next one. When you are entering a command, you can use any path variables and environment variables that are defined in your project, instead of using a hard-coded path. You can also use certain variables that are defined specifically for build event commands. To learn more, see Specifying Commands that Run Before, During, and After Builds. |
Precompression Event |
Basic MSI, InstallScript MSI |
Edition • This setting is available in the Premier edition of InstallShield. Specify the command that you want to be run after InstallShield has built the .msi package and the .cab files (if your product’s data files are to be stored in .cab files). Note that this event occurs after .cab files are streamed into the .msi package, but before the .msi package has been digitally signed and streamed into the Setup.exe file. To specify more than one command, click the ellipsis button (...) in this setting, which opens the Precompression Event dialog box. Enter each command on a separate line in this dialog box. At build time, InstallShield runs each command in the order that they are listed. The build waits until a command finishes before proceeding to the next one. When you are entering a command, you can use any path variables and environment variables that are defined in your project, instead of using a hard-coded path. You can also use certain variables that are defined specifically for build event commands. To learn more, see Specifying Commands that Run Before, During, and After Builds. |
Execute Batch File |
InstallScript, InstallScript Object |
To launch a batch file (.bat) or executable file (.exe) after the release has been built, enter the path to the file, or click the ellipsis button (...) to browse to the file. You can use path variables, enclosed within angle brackets (<>), as part of the path. If you specify a file for this, InstallShield sets environment variables with the same names (including the angle brackets) and values as the project’s build variables. InstallShield also sets the environment variable <ISMEDIADIR>, whose value is the path to the folder in which the release’s Disk Images, Log Files, and Report Files folders are created. You can refer to the value of an environment variable in a batch file by surrounding the variable name with percent signs (%); for example: set PATH = %<ISPROJECTDIR>%;%PATH% When the file is finished, InstallShield deletes the environment variables that it set. |
Postbuild Event |
Basic MSI, InstallScript, InstallScript MSI, Merge Module, Suite/Advanced UI |
Edition • This setting is available in the Premier edition of InstallShield. Specify the command that you want to be run after InstallShield has built and signed the release. To specify more than one command, click the ellipsis button (...) in this setting, which opens the Postbuild Event dialog box. Enter each command on a separate line in this dialog box. At build time, InstallShield runs each command in the order that they are listed. The build waits until a command finishes before proceeding to the next one. When you are entering a command, you can use any path variables and environment variables that are defined in your project, instead of using a hard-coded path. You can also use certain variables that are defined specifically for build event commands. To learn more, see Specifying Commands that Run Before, During, and After Builds. |
The Publishing settings that are displayed depend on what project type you are using; they also depend on whether you are using the version of InstallShield that ships by itself, or the one that is included in AdminStudio.
Publishing Settings in the Version of InstallShield that Ships By Itself (Without AdminStudio)
For the version of InstallShield that ships by itself (without AdminStudio), the settings in the Publishing area on the Events tab are available in merge module projects. Use these settings to specify information such as whether you want the merge module to be available in the Merge Modules folder or a repository after each successful build of the release.
Setting |
Project Type |
Description |
|||||||||
Publish Merge Module |
Merge Module |
Specify whether you want the merge module to be available in the Merge Modules folder or a repository after each successful build of the selected release. Available options are:
To learn more, see Using a Repository to Share Project Elements. |
|||||||||
Repository Name |
Merge Module |
Select the repository where the merge module that you are building should be published when the release is successfully built. Note that this option is available only if one or more repositories have been configured. (To configure a repository, on the Tools menu, click Options, and then click the Repository tab. Use this tab to configure a repository.) |
|||||||||
Display Name |
Merge Module |
Specify a display name for the merge module that you are publishing to the repository. When you select this merge module in the Redistributables view after it has been published to the repository, the display name is available in the details pane. |
|||||||||
Publisher |
Merge Module |
Type the name of the person publishing this merge module to the repository. This name will be displayed in the description pane when you select this merge module in the Redistributables view. When you select this merge module in the Redistributables view after it has been published to the repository, the publisher name is available in the details pane. |
|||||||||
Description |
Merge Module |
Type the description that should be displayed for this merge module. When you select this merge module in the Redistributables view after it has been published to the repository, the description is available in the details pane. |
Publishing Settings in the Version of InstallShield that Ships as Part of AdminStudio
For the version of InstallShield that ships as part of AdminStudio, the settings in the Publishing area on the Events tab are available in Basic MSI projects. Use these settings to specify information such as whether you want the Windows Installer package that you are building to be published to the software repository.
Setting |
Project Type |
Description |
||||||||||||
Publish to AdminStudio Repository |
Basic MSI |
Specify whether you want the Windows Installer package that you are building to be published to the software repository. If you use the software repository to manage a Windows Installer package, the .msi file and all of its other associated files and subfolders are stored in a subfolder of the software repository location that is identified for the package’s Application Catalog. |
||||||||||||
Group |
Basic MSI |
If you select Yes for the Publish to AdminStudio Repository setting and you want to associate the Windows Installer package with one or more groups in the Application Catalog, click the ellipsis button (...) in this setting. The Select Application Manager Groups dialog box opens. Select the check box for each group that you want to contain the Windows Installer package. |
||||||||||||
Update Option |
Basic MSI |
Specify how you want to handle the importing of the Windows Installer package that is built for the selected release into the Application Catalog. Available options are:
|
Use the Distribution area on the Events tab to configure settings for distributing releases to a folder or FTP site automatically at build time.
Setting |
Project Type |
Description |
|||||||||
Copy to Folder |
Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module |
If you want to be able to automatically distribute your release to a folder, specify location. Existing folders with the same names as copied folders are overwritten, but no folders are deleted. Specify the folder path by entering the path in this setting, or click the ellipsis button (...) to browse to the location. If the media format of the selected release is a network image, which creates only one disk image folder, the contents of the disk image folder, rather than the folder itself, are copied. If you chose to create a self-extracting executable file, the executable file, rather than the disk image folders, is copied. Project • For InstallScript and InstallScript Object projects, InstallShield automatically copies the release to the folder that you specify on the Events tab every time that you build the release. For any of the following project types, InstallShield copies all of the relevant files for your release to the specified folder whenever you right-click the release in the Releases view and then click Distribute:
If you want the build engine to copy your release to the specified folder after every build in a Basic MSI, InstallScript MSI, or Merge Module project, select Yes for the Distribute After Build setting. Note • If you specify a folder for this setting and you also specify an FTP location on the Events tab, InstallShield copies the release to only the FTP location. |
|||||||||
FTP Location |
Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module |
If you want to be able to automatically distribute your release to an FTP server, specify the FTP URL for the location. Each release in your project can have a different FTP location. Note • If you need to distribute your release to a path outside the FTP default folder, use a double slash (//). For example, to distribute your release to a root-level folder called myproduct, where the URL of the FTP server is ftp://ftp.mydomain.com, enter ftp://ftp.mydomain.com//myproduct for the FTP location. Project • For InstallScript and InstallScript Object projects, InstallShield automatically copies the release to the FTP location that you specify on the Events tab every time that you build the release. For any of the following project types, InstallShield copies all of the relevant files for your release to the specified FTP location whenever you right-click the release in the Releases view and then click Distribute:
If you want the build engine to copy your release to the specified location after every build in a Basic MSI, InstallScript MSI, or Merge Module project, select Yes for the Distribute After Build setting. |
|||||||||
FTP Site User Name |
Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module |
If a user name is required to upload to the FTP location that you are specifying, enter the user name. Project • If you enter a user name for one of the releases in a Basic MSI, InstallScript MSI, or Merge Module project, that same user name is used for other releases in the same project and in other Basic MSI, InstallScript MSI, and Merge Module projects. |
|||||||||
FTP Site Password |
Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module |
If a password is required to upload to the FTP location that you are specifying, enter the password. Project • If you enter a password for one of the releases in a Basic MSI, InstallScript MSI, or Merge Module project, that same password is used for other releases in the same project and in other Basic MSI, InstallScript MSI, and Merge Module projects. |
|||||||||
Distribute After Build |
Basic MSI, InstallScript MSI, Merge Module |
Specify whether you want the build engine to automatically distribute your release after each build to the location that you specified. Tip • To quickly distribute your release on demand, instead of after each build, right-click the release and click Distribute. Note that the Distribute command is available only if the release has been built at least once. |
Edition • The Virtual Machine area is available in the Premier edition of InstallShield.
Use the Virtual Machine area on the Events tab to configure settings for distributing the selected release to a virtual machine (VM) at build time or on demand. To learn more, see Distributing Releases to a Virtual Machine that InstallShield Provisions at Build Time or on Demand.
Setting |
Project Type |
Description |
|||||||||
Configuration |
Basic MSI, InstallScript, InstallScript MSI, Suite/Advanced UI |
This setting shows the name of the group of VM configuration settings that you want to use when distributing the selected release to a VM. To specify an existing VM configuration, select it in this setting. To create a new VM configuration, click the ellipsis button (...) in this setting. To edit an existing VM configuration, select it in this setting and then click the ellipsis button (...). To override the selected VM configuration’s details (such as the destination on the VM where you want the installation to be distributed) for the selected release, configure the subsettings under this setting. To learn more about VM distribution, see Distributing Releases to a Virtual Machine that InstallShield Provisions at Build Time or on Demand. For information on how to share VM configurations with other machines, see Sharing Virtual Machine Settings for Distribution of Releases. |
|||||||||
Snapshot |
Basic MSI, InstallScript, InstallScript MSI, Suite/Advanced UI |
Optionally specify the name of the snapshot that you want to use for distributing the release. If a snapshot is specified for the VM configuration that is selected in the Configuration setting, the name of that snapshot is considered to be the default value for this setting and displayed in gray text. To override the snapshot for the selected release, enter it in this setting. If no snapshot is specified for the VM configuration, InstallShield does not revert to a specific snapshot. InstallShield powers on the VM without reverting it to a specific snapshot, and copies your installation to the VM. To learn more about VM distribution, see Distributing Releases to a Virtual Machine that InstallShield Provisions at Build Time or on Demand. |
|||||||||
User Name |
Basic MSI, InstallScript, InstallScript MSI, Suite/Advanced UI |
If a user name is specified for the VM configuration that is selected in the Configuration setting, that user name is considered to be the default value for this setting and displayed in gray text. To override the user name for the selected release, enter it in this setting. To learn more about VM distribution, see Distributing Releases to a Virtual Machine that InstallShield Provisions at Build Time or on Demand. |
|||||||||
Password |
Basic MSI, InstallScript, InstallScript MSI, Suite/Advanced UI |
If a password is specified for the VM configuration that is selected in the Configuration setting, that password is considered to be the default value for this setting and displayed in gray text. To override the password for the selected release, enter it in this setting. To learn more about VM distribution, see Distributing Releases to a Virtual Machine that InstallShield Provisions at Build Time or on Demand. |
|||||||||
Destination Path |
Basic MSI, InstallScript, InstallScript MSI, Suite/Advanced UI |
The destination path identifies the location on the VM where the release is to be distributed. The last subfolder in the path can be a path that InstallShield creates on the VM; the other folders in the path must already exist. If a destination path is specified for the VM configuration that is selected in the Configuration setting, that destination path is considered to be the default value for this setting and displayed in gray text. To override the destination path for the selected release, enter it in this setting. To learn more about VM distribution, see Distributing Releases to a Virtual Machine that InstallShield Provisions at Build Time or on Demand. |
|||||||||
Distribute After Build |
Basic MSI, InstallScript, InstallScript MSI, Suite/Advanced UI |
Specify whether you want InstallShield to automatically distribute the selected release each time that it is successfully built. Distributing the release to the VM involves the following tasks:
As an alternative to automatically distributing the release at build time to the VM, you can distribute the release on demand: right-click the release and then click Distribute to VM. To learn more about VM distribution, see Distributing Releases to a Virtual Machine that InstallShield Provisions at Build Time or on Demand. |
See Also
Distributing Releases to a Virtual Machine that InstallShield Provisions at Build Time or on Demand
InstallShield 2019 Help LibraryApril 2019 |
Copyright Information | Flexera |