Configure Settings for Installer Files
- Last UpdatedNov 14, 2023
- 4 minute read
The Installer Files has an unique set of configuration settings required to install, update, and uninstall the installer files.
You can view and edit the configuration settings from one of the following windows:
-
Source Environment > Package Template window (can view and edit the configuration settings)
-
Target Environment > Manage Package window (can only view the configuration settings)
You can define the configuration settings of the Installer Files and set the properties to take appropriate actions while installing, updating, or uninstalling the package.
You can also set the execution timeout for the Installer Files. The execution timeout can be set between 120 to 100000 seconds. The timeout set as 0 second means no timeout is set.
During package installation, if one of the installer file execution is timed out, the package installation stops. To install the package again, set the appropriate timeout to execute the timed out installer files.
As a best practice, each installer file execution should complete within 120 seconds.
During install or update of the package,
-
the installer files configured are executed prior to the installation of the artifacts in the package. However, during uninstallation, the installer files are removed after the artifacts are removed/uninstalled.
-
if any of the installer file execution times out, the package installation or update stops. Also the subsequent installer file is not executed and the artifacts are not installed or updated.
During uninstall, the installer files are removed after the artifacts are uninstalled/removed and if any of the installer file execution times out, the subsequent installer files are not removed.
During package template generation, the installer file certificate is validated online. So, make sure that the internet connectivity is available on the Server where package template is generated.
Note:
- The installer files which were already executed will not be rolled back, even if
the next installer file execution exceeds timeout.
- The timed out installer files will be still running in the background. Make sure
that the execution of the timed out installer files is completed before importing
or executing any other package.
- The package can be generated only if it contains the installer files signed with
valid and trusted certificate.
- Make sure that the firewall does not block the Online Certificate Status Protocol
(OCSP) request. The OCSP is used for obtaining the revocation status of the digital
certificate.
- For Load Balanced Server, make sure all the servers are online while installing
the installer files.
Sample of the Installer File:
msiexec.exe /i "C:\Example.msi" /qn /norestart /L*V "C:\package.log" where,
-
/i is install option (possible options are /a for install, /x for uninstall, and /update for update)
-
%INSTALLERFILEPATH% /qn /norestart gets added during msi execution (%INSTALLERFILEPATH% is the place holder for installer file location)
-
/L*V "C:\package.log" is optional
You need to enter "C:\Example.msi in the Installer File Path text box and /i %INSTALLERFILEPATH% /qn /norestart gets populated in the Command Line Parameters text box. You can further enter /L*V "C:\package.log" (optional) in the Command Line Parameters text box
Note:
- In the Command Line Parameters text box, /i %INSTALLERFILEPATH% /qn /norestart is the default parameter and is automatically taken by the system even if deleted.
You cannot overwrite it. The %INSTALLERFILEPATH% is the place holder for the location of the Installer File.
- If the Installer File is placed on the your machine desktop, the path location will
not be fetched and the package cannot be generated.
- You can add only 5 rows for the Installer Files under each tabs (Install, Update,
and Uninstall).
Install
Use this tab to set the configurations for Installer Files while installing the package.
-
Installer File Path: Enter the location of the installer file. For example, C:\Example.msi
-
Command Line Parameters: Enter the command line parameters for the installer file. The default parameter is /i %INSTALLERFILEPATH% /qn /norestart
-
Disable Execution: Select the check box to skip execution of the installer files. By default, it is unchecked.
Update
Use this tab to set the configurations for Installer Files while updating the package.
-
Installer File Path: Enter the location of the installer file. For example, C:\Example.msi
-
Command Line Parameters: Enter the command line parameters for the installer file. The default parameter is /i %INSTALLERFILEPATH% /qn /norestart REINSTALLMODE=amus
-
Disable Execution: Select the check box to skip execution of the installer files. By default, it is unchecked.
Uninstall
Use this tab to set the configuration of the Installer File when the package is being uninstalled from the target environment.
-
Installer File Path: Enter the location of the installer file.
-
Command Line Parameters: Enter the command line parameters for the installer file. The default parameter is /x %INSTALLERFILEPATH% /qn /norestart
-
Disable Execution: Select the check box to skip execution of the installer files. By default, it is unchecked.
The table shows the status of the package before and after the execution of the package in case of timed out execution.
|
Operation |
Package Status |
|
|---|---|---|
|
Before Execution |
After Execution |
|
|
Install |
Not installed |
Not installed |
|
Installed |
Installed |
|
|
Updated |
Updated |
|
|
Uninstalled |
Uninstalled |
|
|
Uninstall |
Not installed |
Not applicable |
|
Installed |
Uninstalled |
|
|
Updated |
Uninstalled |
|
|
Uninstalled |
Uninstalled |
|