|
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.
|
|