 |
The configurable properties of the three types of applications are listed below:
 Installer | | |
|
The installer is the sequence of screens and actions that are executed when the user invokes the media file. | | Properties: | - Action elevation type [Privileges]
If any contained actions should run in the elevated helper process, if their "Action elevation type" property is set to "Inherit from parent".An elevated helper process is available on Windows and macOS if the process has been started without admin privileges and the "Request privileges" action has been configured to require full privileges. - Style [GUI Options]
The default screen style for this installer application. Screens and screen groups can override this style. - Customize title bar
A form component in the selected style is configured to allow customization of selected properties. - Custom watermark
A form component in the selected style is configured to allow customization of selected properties. - Customize banner image
A form component in the selected style is configured to allow customization of selected properties. - macOS entitlements file [macOS]
If you have configured code signing for macOS, an entitlements file can unlock certain features on macOS, such as iCloud storage or push notifications. - Custom script fragment [Unix]
On Unix and Linux, the JVM for an installer application is launched by a shell script. To add your own code to the shell script, you can specify a script fragment that is added immediately before the java invocation takes place. - Script fragment file [Unix]
The file that contains the script fragment.Note: This property is only visible if "Custom script fragment" is set to "From file". - Script fragment [Unix]
The script fragment.Note: This property is only visible if "Custom script fragment" is set to "Direct entry". - Executable icon [Executable]
By default, a standard installer icon is used for the executable. To customize the icon, press the customizer button in the configuration pane. - Allow unattended mode [Execution Modes]
If selected, the user can pass -q as an argument to run the installer application without a GUI. No user input is required, the installer applications works with the default values. Please see the corresponding help topic on installer modes for more information. All standard actions and standard screens support unattended installations. If your policy forbids unattended installations or if you include custom code that cannot handle unattended installations, you can disable them by deselecting this property. - Progress interface creation script
If you would like to implement your own way of displaying progress information for unattended installations, you can do so by returning a custom implementation of com.install4j.api.context.UnattendedProgressInterface from this script. If you return null, no progress information will be shown just as if this script had not been set. There is a default implementation com.install4j.api.context.DefaultUnattendedProgressInterface that does nothing for all its operations. You can derive from that class if you just need to implement a few particular methods in the progress interface.If you just need a simple dialog that shows progress information in unattended mode, please choose the "Unattended mode with progress dialog" execution mode instead. Note: This property is only visible if "Allow unattended mode" is selected. - Allow console installations [Execution Modes]
If selected, the user can pass -c as an argument to run the installer application on the console. The installer asks for user input on the console in that mode. Please see the corresponding help topic on installer modes for more information. All standard actions and standard screens support console installations, form screens are also fully mapped to console installers. If your policy forbids console installations or if you include custom code that cannot handle console installations, you can disable them by deselecting this property. - Fall back to console mode on Unix
On Unix, users often operate in environments where no X11 server is available and no GUI can be displayed. The installer will fallback to console mode if console mode execution is allowed and this option is selected. Otherwise an error message will be displayed that tells the user how to invoke the installer in console mode.Note: This property is only visible if "Allow console installations" is selected. - Disable console mode on Windows
Offer console mode only on non-Windows platforms.Note: This property is only visible if "Allow console installations" is selected. - Console screen change handler
By default, a screen in console mode does not show any particular separation. You insert your own custom display with this script. The title parameter gives you access to the title of the screen. In console mode, screens display their subtitle only, so the title string will not be displayed again.Note: This property is only visible if "Allow console installations" is selected. - Default execution mode [Execution Modes]
The default execution mode for the installer application. By default, a GUI wizard will be shown, but it is also possible to run in console mode or unattended mode by default. - Title for progress dialog
The title for the progress dialog, for example "Updating installation".This title and the unattended mode with a progress window can also be set by passing -splash [title] as an argument from the command line.Note: This property is only visible if "Default execution mode" is set to "Unattended mode with progress dialog". - Windows console executable [Execution Modes]
If selected, a console executable will be created on Windows. A non-hideable console will be shown when the installer is double-clicked in the explorer. This improves the user experience for a console-only installer (default execution mode set to console) and allows execution through rsh. - VM parameters [Execution Options]
If you need to pass special VM parameters to the installer application, you can enter them here. A common case would be to raise the maximum heap size with a different -Xmx parameter if your installers require a lot of memory. - Arguments [Execution Options]
If you need to pass fixed default arguments to the installer application, you can enter them here. For example, if you want to display a splash screen in unattended mode by default, you can set the arguments to -splash "Installing ...". Please note that command line arguments will be appended to this list, so it is not possible to "override" a fixed argument from the command line. - Rollback on failure [Execution Options]
If selected, the installer application will try to restore the state before the last rollback barrier by rolling back all actions that were executed since the last barrier. Any screen or action can be selected as a rollback barrier with the property "Rollback barrier". If no rollback barrier was encountered, all executed actions will be rolled back. - Suppress initial progress dialog [Execution Options]
If selected, the initial native progress dialog of the installer is not displayed. - Window width [GUI Options]
The width of the window displayed by the installer application. The default value is 500. If the "Size client area" property is selected, this does not include the size of the window frame border. - Window height [GUI Options]
The height of the window displayed by the installer application. The default value is 390.If the "Size client area" property is selected, this does not include the size of the window frame border. - Size client area [GUI Options]
If selected, the supplied size for the window will not be applied to the outer dimensions of the window, but to the actually usable area inside the window. Unusually large window frame borders can occur due to user settings (accessibility, window themes, etc.) and may interfere with banner images or introduce unwanted scroll bars to form screens. - Resizable [GUI Options]
If selected, the window displayed by the installer application is resizable. - Help customizer script [General Customization Options]
If the user starts the installer application with one of the arguments -h -help /?, help regarding the available command line options will be displayed. If you have your own command line options you can customize this help with this script. The script receives a List containing String arrays of length 2 with the options and explanations. You can add options like this: options.add(new String[] {"/mySwitch", "Explanation of mySwitch"}}. You can also delete default options in the list.Attention: The context parameter has not been initialized at that point.In order to get extra command line arguments in the installer, call context.getExtraCommandLineArguments() in any script. - Replacement script for language code [General Customization Options]
With this script you can replace the language that the installer will run with. Parameters: The parameter languageCode contains the 2-letter ISO 639 code of the auto-detected language. If auto-detection has not been enabled on the languages step of the general settings, the parameter will be null. Return value: If you return null, the language selection dialog will be shown, if you return a language code, the language selection dialog will not be shown and the returned language will be used. If the returned language code is a language that is not configured for this installer, the language selection dialog will be shown. - Customize version info [Windows]
If selected, you can customize the fields of the Windows version info in the nested properties. A windows version info is always generated for the executable with default values for product name and file version taken from the general settings. - Product name
The product name field in the version resource. If empty, the full name from the general settings is used.Note: This property is only visible if "Customize version info" is selected. - File version
The file version field in the version resource. If empty, the version from the general settings is used. The file version must consist of 4 numbers separated by spaces, commas or dots.Note: This property is only visible if "Customize version info" is selected. - Internal name
The internal name field in the version resource. If empty, the short name from the general settings is used.Note: This property is only visible if "Customize version info" is selected. - File description
The file description field in the version resource. If empty, the full name from the general settings is used.Note: This property is only visible if "Customize version info" is selected. - Copyright
The copyright field in the version resource. If empty, the publisher name from the general settings is used.Note: This property is only visible if "Customize version info" is selected. - Create log file for stderr output [Windows]
If selected, and output on stderr is detected, an file named error.log will be created next to the installer and all output to stderr will be redirected to that file.
|
|
 Uninstaller | | |
|
The uninstaller removes the installed application. If you do not wish to provide an uninstaller, you can disable it. | | Properties: | - Action elevation type [Privileges]
If any contained actions should run in the elevated helper process, if their "Action elevation type" property is set to "Inherit from parent".An elevated helper process is available on Windows and macOS if the process has been started without admin privileges and the "Request privileges" action has been configured to require full privileges. - Style [GUI Options]
The default screen style for this installer application. Screens and screen groups can override this style. - Customize title bar
A form component in the selected style is configured to allow customization of selected properties. - Custom watermark
A form component in the selected style is configured to allow customization of selected properties. - Customize banner image
A form component in the selected style is configured to allow customization of selected properties. - macOS entitlements file [macOS]
If you have configured code signing for macOS, an entitlements file can unlock certain features on macOS, such as iCloud storage or push notifications. - Custom script fragment [Unix]
On Unix and Linux, the JVM for an installer application is launched by a shell script. To add your own code to the shell script, you can specify a script fragment that is added immediately before the java invocation takes place. - Script fragment file [Unix]
The file that contains the script fragment.Note: This property is only visible if "Custom script fragment" is set to "From file". - Script fragment [Unix]
The script fragment.Note: This property is only visible if "Custom script fragment" is set to "Direct entry". - Executable icon [Executable]
By default, a standard installer icon is used for the executable. To customize the icon, press the customizer button in the configuration pane. - Executable name [Executable]
The name of the executable for the uninstaller. Please enter a name without any path components and without a file extension. - Executable directory [Executable]
The directory to which the executable of the uninstaller will be written. If empty, it will be placed in the .install4j directory. - Allow unattended mode [Execution Modes]
If selected, the user can pass -q as an argument to run the installer application without a GUI. No user input is required, the installer applications works with the default values. Please see the corresponding help topic on installer modes for more information. All standard actions and standard screens support unattended installations. If your policy forbids unattended installations or if you include custom code that cannot handle unattended installations, you can disable them by deselecting this property. - Progress interface creation script
If you would like to implement your own way of displaying progress information for unattended installations, you can do so by returning a custom implementation of com.install4j.api.context.UnattendedProgressInterface from this script. If you return null, no progress information will be shown just as if this script had not been set. There is a default implementation com.install4j.api.context.DefaultUnattendedProgressInterface that does nothing for all its operations. You can derive from that class if you just need to implement a few particular methods in the progress interface.If you just need a simple dialog that shows progress information in unattended mode, please choose the "Unattended mode with progress dialog" execution mode instead. Note: This property is only visible if "Allow unattended mode" is selected. - Allow console installations [Execution Modes]
If selected, the user can pass -c as an argument to run the installer application on the console. The installer asks for user input on the console in that mode. Please see the corresponding help topic on installer modes for more information. All standard actions and standard screens support console installations, form screens are also fully mapped to console installers. If your policy forbids console installations or if you include custom code that cannot handle console installations, you can disable them by deselecting this property. - Fall back to console mode on Unix
On Unix, users often operate in environments where no X11 server is available and no GUI can be displayed. The installer will fallback to console mode if console mode execution is allowed and this option is selected. Otherwise an error message will be displayed that tells the user how to invoke the installer in console mode.Note: This property is only visible if "Allow console installations" is selected. - Disable console mode on Windows
Offer console mode only on non-Windows platforms.Note: This property is only visible if "Allow console installations" is selected. - Console screen change handler
By default, a screen in console mode does not show any particular separation. You insert your own custom display with this script. The title parameter gives you access to the title of the screen. In console mode, screens display their subtitle only, so the title string will not be displayed again.Note: This property is only visible if "Allow console installations" is selected. - Default execution mode [Execution Modes]
The default execution mode for the installer application. By default, a GUI wizard will be shown, but it is also possible to run in console mode or unattended mode by default. - Title for progress dialog
The title for the progress dialog, for example "Updating installation".This title and the unattended mode with a progress window can also be set by passing -splash [title] as an argument from the command line.Note: This property is only visible if "Default execution mode" is set to "Unattended mode with progress dialog". - Windows console executable [Execution Modes]
If selected, a console executable will be created on Windows. A non-hideable console will be shown when the installer is double-clicked in the explorer. This improves the user experience for a console-only installer (default execution mode set to console) and allows execution through rsh. - VM parameters [Execution Options]
If you need to pass special VM parameters to the installer application, you can enter them here. A common case would be to raise the maximum heap size with a different -Xmx parameter if your installers require a lot of memory. - Arguments [Execution Options]
If you need to pass fixed default arguments to the installer application, you can enter them here. For example, if you want to display a splash screen in unattended mode by default, you can set the arguments to -splash "Installing ...". Please note that command line arguments will be appended to this list, so it is not possible to "override" a fixed argument from the command line. - Rollback on failure [Execution Options]
If selected, the installer application will try to restore the state before the last rollback barrier by rolling back all actions that were executed since the last barrier. Any screen or action can be selected as a rollback barrier with the property "Rollback barrier". If no rollback barrier was encountered, all executed actions will be rolled back. - Window width [GUI Options]
The width of the window displayed by the installer application. The default value is 500. If the "Size client area" property is selected, this does not include the size of the window frame border. - Window height [GUI Options]
The height of the window displayed by the installer application. The default value is 390.If the "Size client area" property is selected, this does not include the size of the window frame border. - Size client area [GUI Options]
If selected, the supplied size for the window will not be applied to the outer dimensions of the window, but to the actually usable area inside the window. Unusually large window frame borders can occur due to user settings (accessibility, window themes, etc.) and may interfere with banner images or introduce unwanted scroll bars to form screens. - Resizable [GUI Options]
If selected, the window displayed by the installer application is resizable. - Help customizer script [General Customization Options]
If the user starts the installer application with one of the arguments -h -help /?, help regarding the available command line options will be displayed. If you have your own command line options you can customize this help with this script. The script receives a List containing String arrays of length 2 with the options and explanations. You can add options like this: options.add(new String[] {"/mySwitch", "Explanation of mySwitch"}}. You can also delete default options in the list.Attention: The context parameter has not been initialized at that point.In order to get extra command line arguments in the installer, call context.getExtraCommandLineArguments() in any script. - Unix mode [Unix]
The executable mode for the uninstaller on Unix. - Customize version info [Windows]
If selected, you can customize the fields of the Windows version info in the nested properties. A windows version info is always generated for the executable with default values for product name and file version taken from the general settings. - Product name
The product name field in the version resource. If empty, the full name from the general settings is used.Note: This property is only visible if "Customize version info" is selected. - File version
The file version field in the version resource. If empty, the version from the general settings is used. The file version must consist of 4 numbers separated by spaces, commas or dots.Note: This property is only visible if "Customize version info" is selected. - Internal name
The internal name field in the version resource. If empty, the short name from the general settings is used.Note: This property is only visible if "Customize version info" is selected. - File description
The file description field in the version resource. If empty, the full name from the general settings is used.Note: This property is only visible if "Customize version info" is selected. - Copyright
The copyright field in the version resource. If empty, the publisher name from the general settings is used.Note: This property is only visible if "Customize version info" is selected. - Use custom application bundle name [macOS]
If selected, a different application bundle name is used on macOS. Executable names on macOS are localizable. Otherwise, the value of the "Executable name" property is used for the application bundle name. - Custom application bundle name
The application bundle name to be used for macOS media files. Bundle names on macOS are shown in the Finder and are localizable. For example, the executable name could be set to ${i18n:myLauncherName(${compiler:sys.fullName})} where myLauncherName is an i18n message with value "Launcher for {0}".Note: This property is only visible if "Use custom application bundle name" is selected.
|
|
 Custom application | | |
|
A custom installer application is installed by the installer. Users can start it manually or it can be executed programmatically from your own code via the API. | | Properties: | - Action elevation type [Privileges]
If any contained actions should run in the elevated helper process, if their "Action elevation type" property is set to "Inherit from parent".An elevated helper process is available on Windows and macOS if the process has been started without admin privileges and the "Request privileges" action has been configured to require full privileges. - Style [GUI Options]
The default screen style for this installer application. Screens and screen groups can override this style. - Customize title bar
A form component in the selected style is configured to allow customization of selected properties. - Custom watermark
A form component in the selected style is configured to allow customization of selected properties. - Customize banner image
A form component in the selected style is configured to allow customization of selected properties. - macOS entitlements file [macOS]
If you have configured code signing for macOS, an entitlements file can unlock certain features on macOS, such as iCloud storage or push notifications. - Custom script fragment [Unix]
On Unix and Linux, the JVM for an installer application is launched by a shell script. To add your own code to the shell script, you can specify a script fragment that is added immediately before the java invocation takes place. - Script fragment file [Unix]
The file that contains the script fragment.Note: This property is only visible if "Custom script fragment" is set to "From file". - Script fragment [Unix]
The script fragment.Note: This property is only visible if "Custom script fragment" is set to "Direct entry". - Executable icon [Executable]
By default, a standard installer icon is used for the executable. To customize the icon, press the customizer button in the configuration pane. - File set [Executable]
Choose the file set to which the installer application is added. File sets can be defined on the Files->Define Distribution Tree step. - Executable name [Executable]
The name of the executable for the custom application. Please enter a name without any path components and without a file extension. - Executable directory [Executable]
The directory to which the executable of the custom application will be written. If empty, it will be placed in the .install4j directory. - Allow unattended mode [Execution Modes]
If selected, the user can pass -q as an argument to run the installer application without a GUI. No user input is required, the installer applications works with the default values. Please see the corresponding help topic on installer modes for more information. All standard actions and standard screens support unattended installations. If your policy forbids unattended installations or if you include custom code that cannot handle unattended installations, you can disable them by deselecting this property. - Progress interface creation script
If you would like to implement your own way of displaying progress information for unattended installations, you can do so by returning a custom implementation of com.install4j.api.context.UnattendedProgressInterface from this script. If you return null, no progress information will be shown just as if this script had not been set. There is a default implementation com.install4j.api.context.DefaultUnattendedProgressInterface that does nothing for all its operations. You can derive from that class if you just need to implement a few particular methods in the progress interface.If you just need a simple dialog that shows progress information in unattended mode, please choose the "Unattended mode with progress dialog" execution mode instead. Note: This property is only visible if "Allow unattended mode" is selected. - Allow console installations [Execution Modes]
If selected, the user can pass -c as an argument to run the installer application on the console. The installer asks for user input on the console in that mode. Please see the corresponding help topic on installer modes for more information. All standard actions and standard screens support console installations, form screens are also fully mapped to console installers. If your policy forbids console installations or if you include custom code that cannot handle console installations, you can disable them by deselecting this property. - Fall back to console mode on Unix
On Unix, users often operate in environments where no X11 server is available and no GUI can be displayed. The installer will fallback to console mode if console mode execution is allowed and this option is selected. Otherwise an error message will be displayed that tells the user how to invoke the installer in console mode.Note: This property is only visible if "Allow console installations" is selected. - Disable console mode on Windows
Offer console mode only on non-Windows platforms.Note: This property is only visible if "Allow console installations" is selected. - Console screen change handler
By default, a screen in console mode does not show any particular separation. You insert your own custom display with this script. The title parameter gives you access to the title of the screen. In console mode, screens display their subtitle only, so the title string will not be displayed again.Note: This property is only visible if "Allow console installations" is selected. - Default execution mode [Execution Modes]
The default execution mode for the installer application. By default, a GUI wizard will be shown, but it is also possible to run in console mode or unattended mode by default. - Title for progress dialog
The title for the progress dialog, for example "Updating installation".This title and the unattended mode with a progress window can also be set by passing -splash [title] as an argument from the command line.Note: This property is only visible if "Default execution mode" is set to "Unattended mode with progress dialog". - Windows console executable [Execution Modes]
If selected, a console executable will be created on Windows. A non-hideable console will be shown when the installer is double-clicked in the explorer. This improves the user experience for a console-only installer (default execution mode set to console) and allows execution through rsh. - Change working directory [Execution Options]
If selected the working directory will be changed to the value in 'Working directory' at startup. - Working directory
The working directory to be used when 'Change working directory' is selected.Note: This property is only visible if "Change working directory" is selected. - Single instance [Execution Options]
If checked the application will ensure at startup that there is only one instance running per user account. - VM parameters [Execution Options]
If you need to pass special VM parameters to the installer application, you can enter them here. A common case would be to raise the maximum heap size with a different -Xmx parameter if your installers require a lot of memory. - Arguments [Execution Options]
If you need to pass fixed default arguments to the installer application, you can enter them here. For example, if you want to display a splash screen in unattended mode by default, you can set the arguments to -splash "Installing ...". Please note that command line arguments will be appended to this list, so it is not possible to "override" a fixed argument from the command line. - Rollback on failure [Execution Options]
If selected, the installer application will try to restore the state before the last rollback barrier by rolling back all actions that were executed since the last barrier. Any screen or action can be selected as a rollback barrier with the property "Rollback barrier". If no rollback barrier was encountered, all executed actions will be rolled back. - Window title [GUI Options]
The title of the application window. - Show message when user cancels [GUI Options]
If selected, a message will be shown when the user cancels the installer application by clicking on the "Cancel" button or closing the application frame. - Cancel message
The message that is shown if the user cancels the installer application by clicking on the "Cancel" button or closing the application frame. The options that are presented to the user are "Cancel" or "Continue".Note: This property is only visible if "Show message when user cancels" is selected. - Window width [GUI Options]
The width of the window displayed by the installer application. The default value is 500. If the "Size client area" property is selected, this does not include the size of the window frame border. - Window height [GUI Options]
The height of the window displayed by the installer application. The default value is 390.If the "Size client area" property is selected, this does not include the size of the window frame border. - Size client area [GUI Options]
If selected, the supplied size for the window will not be applied to the outer dimensions of the window, but to the actually usable area inside the window. Unusually large window frame borders can occur due to user settings (accessibility, window themes, etc.) and may interfere with banner images or introduce unwanted scroll bars to form screens. - Resizable [GUI Options]
If selected, the window displayed by the installer application is resizable. - Help customizer script [General Customization Options]
If the user starts the installer application with one of the arguments -h -help /?, help regarding the available command line options will be displayed. If you have your own command line options you can customize this help with this script. The script receives a List containing String arrays of length 2 with the options and explanations. You can add options like this: options.add(new String[] {"/mySwitch", "Explanation of mySwitch"}}. You can also delete default options in the list.Attention: The context parameter has not been initialized at that point.In order to get extra command line arguments in the installer, call context.getExtraCommandLineArguments() in any script. - Unix mode [Unix]
The executable mode for the custom application on Unix. - Execution level [Windows]
The execution level for this application. If you want to modify files in the installation direction, you most likely need administrator rights. This is only relevant for Windows Vista and higher. - Customize version info [Windows]
If selected, you can customize the fields of the Windows version info in the nested properties. A windows version info is always generated for the executable with default values for product name and file version taken from the general settings. - Product name
The product name field in the version resource. If empty, the full name from the general settings is used.Note: This property is only visible if "Customize version info" is selected. - File version
The file version field in the version resource. If empty, the version from the general settings is used. The file version must consist of 4 numbers separated by spaces, commas or dots.Note: This property is only visible if "Customize version info" is selected. - Internal name
The internal name field in the version resource. If empty, the short name from the general settings is used.Note: This property is only visible if "Customize version info" is selected. - File description
The file description field in the version resource. If empty, the full name from the general settings is used.Note: This property is only visible if "Customize version info" is selected. - Copyright
The copyright field in the version resource. If empty, the publisher name from the general settings is used.Note: This property is only visible if "Customize version info" is selected. - Use custom application bundle name [macOS]
If selected, a different application bundle name is used on macOS. Executable names on macOS are localizable. Otherwise, the value of the "Executable name" property is used for the application bundle name. - Custom application bundle name
The application bundle name to be used for macOS media files. Bundle names on macOS are shown in the Finder and are localizable. For example, the executable name could be set to ${i18n:myLauncherName(${compiler:sys.fullName})} where myLauncherName is an i18n message with value "Launcher for {0}".Note: This property is only visible if "Use custom application bundle name" is selected.
|
|
|
Add
button on the right side of the list and choosing