| Category: Miscellaneous
Add VM options |
|
Adds VM options for a launcher by modifying or creating a .vmoptions file or by changing the Info.plist file. This action will be automatically reverted by the 'Uninstall files' action. |
Applies to: Installation |
Properties: |
-
Launcher
The launcher that the VM options should be added for.
-
VM options
The unquoted options that should be added. Note that system property definitions must be prefixed with -D just as on the command line, e.g. -Dkey=value. The items in the list must be separated by semicolons followed by a space. If you click on the edit button in the property editor, you can enter one item per line in a separate dialog. VM options that are installer variables with array values (e.g. String[], Object[] or File[]) are expanded as separate VM options, this allows you to build a variable length list of VM options at runtime.
-
Target file on Mac OS X [Mac OS X]
For application bundles on Mac OS X, there are two locations for .vmoptions files. One in the "Contents" directory inside the application bundle, and the other next to the application bundle. Both files are read by the launcher, but the contained file takes precedence. If the launcher is signed, you should choose the location next to the application bundle, otherwise the signature will be broken.
|
|
Check for running processes on Windows |
|
Check for installed launchers and additional running processes on Windows. |
Applies to: Installation, Uninstallation |
Properties: |
-
Include launchers
If selected, the operation will check for running launchers in the current installation directory.
-
Additional executables
The additional executables that should be checked. Multiple files are separated by semicolons. Use the chooser button to the right side of the text field to display a dialog where you can conveniently choose files from the distribution tree. Additional executables that are installer variables with array values (e.g. String[], Object[] or File[]) are expanded as separate additional executables, this allows you to build a variable length list of additional executables at runtime. From relative files, only the file name is used for comparison. This enables checking for executables with an unknown location. To reference executables relative to your installation directory, please prefix them with ${installer:sys.installationDir}/. This is an optional property.
-
Close strategy
The strategy used when processes are running.
-
Ignore button
Add an ignore button to the dialog. The action will return successfully if the user clicks this button.
-
Time out for close
The time out for the soft close strategy in milliseconds.
-
Message
The message to be displayed at the top of the dialog.
|
|
Modify an environment variable on Windows |
|
Sets, appends to, or prepends to an environment variable on Windows. This action can be automatically reverted by the 'Uninstall files' action. |
Applies to: Installation, Uninstallation |
Properties: |
|
|
Modify classpath |
|
Changes the classpath of a launcher by modifying or creating a .vmoptions file or by changing the Info.plist file. This action will be automatically reverted by the 'Uninstall files' action. |
Applies to: Installation |
Properties: |
-
Launcher
The launcher that the classpath should be changed for.
-
Classpath entries
The classpath entries. The items in the list must be separated by semicolons followed by a space. If you click on the edit button in the property editor, you can enter one item per line in a separate dialog. Entries that are installer variables with array values (e.g. String[], Object[] or File[]) are expanded as separate entries, this allows you to build a variable length list of entries at runtime.
-
Modification type
Modification type
-
Target file on Mac OS X [Mac OS X]
For application bundles on Mac OS X, there are two locations for .vmoptions files. One in the "Contents" directory inside the application bundle, and the other next to the application bundle. Both files are read by the launcher, but the contained file takes precedence. If the launcher is signed, you should choose the location next to the application bundle, otherwise the signature will be broken.
|
|
Request privileges |
|
Requests configurable administrator privileges. On Windows Vista and higher and on OS X, the installer will be restarted with the requested privileges or a helper process will be created that can perform certain actions in a privileged context. When you restart the installer, you should not install files before this action. Please see the help topic on "Elevation Of Privileges" for a detailed discussion of this action. |
Applies to: Installation, Uninstallation |
Properties: |
-
Try to obtain root privileges if admin user [Mac OS X]
If set and the user is an admin user, the action will try to start a new process with root privileges. The user will have to enter his password.
-
Try to obtain root privileges if normal user [Mac OS X]
If set and the user is a non-admin user, the action will try to start a new process with root privileges. The user will have to enter the password of an admin account.
-
Show failure if requested privileges cannot be obtained [Mac OS X]
If set and the privileges required above could not be obtained a failure message will be shown and the installation will be canceled. This property overrides the "Failure strategy" property of the action. A separate property is necessary since the behavior can be configured differently for Windows, Mac OS X and Unix.
-
Show failure if current user is not root [Unix]
If set and the current user is not root a failure message will be shown and the installation will be canceled. This property overrides the "Failure strategy" property of the action. A separate property is necessary since the behavior can be configured differently for Windows, Mac OS X and Unix.
-
Try to obtain full privileges if admin user [Windows]
If set and the user is an admin user with limited privileges on Vista and higher, the action will try to start a new process with full privileges.
-
Try to obtain full privileges if normal user [Windows]
If set and the user is a non-admin user, the action will either try to start a new process with full privileges on Vista and higher or fail on previous versions of Windows.
-
Show failure if requested privileges cannot be obtained [Windows]
If set and the privileges required above could not be obtained a failure message will be shown and the installation will be canceled. This property overrides the "Failure strategy" property of the action. A separate property is necessary since the behavior can be configured differently for Windows, Mac OS X and Unix.
|
|
Require installer privileges |
|
Require the same privileges as the ones that were obtained during the installation. On Windows Vista and higher and on Mac OS X, the uninstaller or custom installer application will be restarted with the requested privileges if necessary. This action only has an effect if a "Load response file" action is executed previously. Please see the help topic on "Elevation Of Privileges" for a detailed discussion of this action. |
Applies to: Installation, Uninstallation |
Properties: |
-
Show failure if required privileges cannot be obtained [General]
If set and the privileges that were obtained in the installer could not be obtained by this action, a failure message will be shown and the installer application will be canceled.
|
|
Run executable or batch file |
|
Runs an executable or a Windows batch file. The action can optionally wait for termination of the executable. |
Applies to: Installation, Uninstallation |
Properties: |
-
Executable
The file that should be executed. Please do not add arguments here, there is a separate "Arguments" property.
-
Working directory
The working directory for the execution.
-
Arguments
The arguments passed to the executable. Please note that in the property sheet, arguments have to be separated by semicolons (;) and in the edit dialog each argument starts on a new line. The items in the list must be separated by semicolons followed by a space. If you click on the edit button in the property editor, you can enter one item per line in a separate dialog. Arguments that are installer variables with array values (e.g. String[], Object[] or File[]) are expanded as separate arguments, this allows you to build a variable length list of arguments at runtime.
-
Use rollback executable
If selected, an executable is invoked in the case of rollback. You can configure the executable with the child properties. All other properties, such as redirection and environment variables are shared with the regular executable.
-
Rollback executable
The file that should be executed in the case of rollback. Please do not add arguments here, there is a separate "Arguments" property.
Note: This property is only visible if "Use rollback executable" is selected.
-
Rollback working directory
The working directory for the execution of the rollback executable.
Note: This property is only visible if "Use rollback executable" is selected.
-
Rollback arguments
The arguments passed to the rollback executable. Please note that in the property sheet, arguments have to be separated by semicolons (;) and in the edit dialog each argument starts on a new line. The items in the list must be separated by semicolons followed by a space. If you click on the edit button in the property editor, you can enter one item per line in a separate dialog. Arguments that are installer variables with array values (e.g. String[], Object[] or File[]) are expanded as separate arguments, this allows you to build a variable length list of arguments at runtime.
Note: This property is only visible if "Use rollback executable" is selected.
-
Wait for termination
If the action should wait for termination of the process and check if the return value is 0.
-
Variable name for return code
If set, the return code will be saved to this installer variable. The type of the variable will be java.lang.Integer. Under Windows, this variable will always be equal to 0 if the "Show console window" option below is selected.If a timeout has been set and the process is killed after the timeout, the return value will be -10000.
Note: This property is only visible if "Wait for termination" is selected.
-
Timeout in seconds
If set to a value greater than 0, the executable will be killed after that number of seconds if it does not return earlier.In that case, the return value will be -10000.
Note: This property is only visible if "Wait for termination" is selected.
-
Wait for output streams
If selected, the action will wait until the output streams of the process are fully written. If the process has launched child processes, this can mean that the action will wait until those child processes have terminated. If that is not desired, please deselect this option.
Note: This property is only visible if "Wait for termination" is selected.
-
Log arguments
If the arguments should be written into the log file or not. Disabled by default due to security reasons.
-
Include parent environment variables [Environment Variables]
If selected, the environment variables of the parent process (the installer) will be set. Otherwise, only the environment variables in the "Specific environment variables" will be set. This option is ignored on OS X.
-
Specific environment variables [Environment Variables]
Specify additional or modified environment variables that should be set for the executed process. Use the button to the right side to open a dialog for easy entry or enter a list of definitions separated by semicolons like VAR1=value1;VAR2=value2. Use previous values with the syntax "PATH=${PATH};additional". In this case the entire entry has to be quoted, otherwise the semicolon would have been a separator. Do not quote semicolons in the dialog. Variable definitions that are installer variables with array values (e.g. String[], Object[] or File[]) are expanded as separate variable definitions, this allows you to build a variable length list of variable definitions at runtime.
-
Redirect stdout [Redirection]
Redirection mode for stdout
-
Installer variable name
An installer variable name to which the stdout output of the executed process is saved. The contents of the variable will not be displayed in the log file.
Note: This property is only visible if "Redirect stdout" is set to "To installer variable".
-
Redirection file
A file to which the stdout output of the executed process is saved. If you specify /dev/stdout, the output will be printed to the default stdout stream of the installer application. Relative paths are relative to the working directory of the installer application. In order to use a file in the installation directory, enter a path like ${installer:sys.installationDir}/log.txt.
Note: This property is only visible if "Redirect stdout" is set to "To file".
-
Fail on error
If selected, the action fails if the redirection file cannot be written. Otherwise, errors are silently ignored.
Note: This property is only visible if "Redirect stdout" is set to "To file".
-
Redirect stderr [Redirection]
Redirection mode for stderr
-
Installer variable name
An installer variable name to which the stderr output of the executed process is saved. The contents of the variable will not be displayed in the log file.
Note: This property is only visible if "Redirect stderr" is set to "To installer variable".
-
Redirection file
A file to which the stderr output of the executed process is saved. If you specify /dev/stderr, the output will be printed to the default stderr stream of the installer application. Relative paths are relative to the working directory of the installer application. In order to use a file in the installation directory, enter a path like ${installer:sys.installationDir}/log.txt.
Note: This property is only visible if "Redirect stderr" is set to "To file".
-
Fail on error
If selected, the action fails if the redirection file cannot be written. Otherwise, errors are silently ignored.
Note: This property is only visible if "Redirect stderr" is set to "To file".
-
Redirect stdin [Redirection]
Redirection mode for stdin
-
Input string
A string that should be fed to the input stream of the executed process.
Note: This property is only visible if "Redirect stdin" is set to "From string".
-
Redirection file
A file which should be fed to the input stream of the executed process. If you specify /dev/stdin, the input from the default stdin stream of the installer application will be used. Relative paths are relative to the working directory of the installer application. In order to use a file in the installation directory, enter a path like ${installer:sys.installationDir}/log.txt.
Note: This property is only visible if "Redirect stdin" is set to "From file".
-
Fail on error
If selected, the action fails if the redirection file cannot be written. Otherwise, errors are silently ignored.
Note: This property is only visible if "Redirect stdin" is set to "From file".
-
Show console window [Windows]
Show a console window with the console output of the executable. This makes only sense if a command line executable is called and has no effect on Windows 9x.
-
Keep console window
If selected, the console window will not be closed when the executable has finished. The user has to close the console window manually. This can be useful for debugging purposes. If the "Wait for termination" property is selected, the action will not terminate until the user has closed the console window.
Note: This property is only visible if "Show console window" is selected.
|
|
|