| 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. 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.
|
|
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. 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
|
|
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.
-
Obtain privileges for [Mac OS X]
If an elevation should be performed, either the main installation process will be restarted and all actions will run elevated or an elevated helper process will be started that can execute particular actions (install service etc.) elevated in the further installation process.
-
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.
-
Obtain privileges for [Windows]
If an elevation should be performed, either the main installation process will be restarted and all actions will run elevated or an elevated helper process will be started that can execute particular actions (install service etc.) elevated in the further installation process.
-
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.
|
|
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. 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.
-
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.
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.
-
Execution account
On Windows Vista or higher and Mac OS X, you can specify the type of account the process should use. You have to add a 'Request privileges' before this action if you want it to run with admin rights.Please see the help topic on "Elevation Of Privileges" for more information.
-
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.
-
Redirection file for stdout [Redirection]
A file to which the stdout output of the executed process is saved. If empty, the stdout output will be discarded. 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.
-
Redirection file for stderr [Redirection]
A file to which the stderr output of the executed process is saved. If empty, the stderr output will be discarded. 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.
-
Redirection file for stdin [Redirection]
A file which should be fed to the input stream of the executed process. If empty, the stdin input will be empty. 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.
-
Fail for redirection errors [Redirection]
If selected, the action fails if the redirection files cannot be accessed. Otherwise, those errors are silently ignored.
-
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.
|
|
|