| List | Description |
| |
Depending on the complexity of your software, you may need to split your installation files into several components. The ability to enable and disable components allows your installer to provide as many setup combinations as you need. |
| |
Language files for customizing the installer translation |
|
| |
License files to be accepted by the user during the installation |
| |
Pages that are displayed to the user through the GUI and text interfaces |
| |
Platform-specific project options |
| |
Text files to be displayed after the installation |
| |
/bin;/boot;/dev;/etc;/etc/init.d;/home;/lib;/lib64;/mnt;/opt;/root;/sbin;/usr;/var;/usr/bin;/usr/include;/usr/lib;/usr/lib64;/usr/sbin;/usr/share;/usr/src;/usr/local/bin;/usr/local/lib;/usr/local/lib64;/usr/local/sbin;/var/lib;/var/log |
string |
Directories that should not be added in RPM packages (unless custom SPEC file is used) |
| |
Images to be displayed during the installation |
| property | default value | allowed values | description |
| abortOnError |
|
0, 1 |
Whether or not to abort the installation on an error while executing the action. |
| breakpoint |
|
0, 1 |
Breakpoint |
| customErrorMessage |
|
string |
Show a custom error message. |
| explanation |
|
|
Additional text to show when the action is displayed on the final page action list. |
| progressText |
|
string |
Text to show on the progress bar or final page action List |
| ruleEvaluationLogic |
|
and, or |
Boolean operator for rule concatenation |
| run |
|
0, 1 |
Whether or not to run the related action or not |
| show |
|
0, 1 |
Show or hide the checkbutton in the final page action list |
| showMessageOnError |
|
0, 1 |
Whether or not to show an error message when an error occurs. |
| onErrorActionList |
Actions executed if there is an error |
| ruleList |
Conditions that are evaluated and depending on the result, the action is executed, the page associated with the parameter shown or the folder installed |
Group a set of actions.
| property | default value | allowed values | description |
| actionList |
|
string |
List of actions to be grouped |
Add options to an existing choice parameter
| property | default value | allowed values | description |
| optionList |
|
string |
List of options to give to a choice parameter |
| name |
|
string |
Name of an existing choice parameter. |
Add options to an existing choice parameter from a given text
| property | default value | allowed values | description |
| text |
|
|
Text with the options to give to a choice parameter |
| name |
|
string |
Name of an existing choice parameter. |
Add directories to the uninstaller.
| property | default value | allowed values | description |
| matchHiddenFiles |
0 |
0, 1 |
Whether or not to attempt to match Windows hidden files |
| excludeFiles |
|
string |
Patterns to exclude files |
| files |
|
string |
File patterns to apply action to |
| addContents |
0 |
0, 1 |
Whether or not to add directory contents to the uninstaller |
Add a directory to the system path. This will modify the registry on windows and the appropiate shell initialization files on Unix systems
| property | default value | allowed values | description |
| path |
|
|
Path to the directory |
| scope |
system |
system, user |
Select user path or system path. |
| insertAt |
end |
beginning, end |
Where to insert the new directory in the PATH (currently Unix only) |
Add a system environment variable.This will modify the registry on windows and the appropiate shell initialization files on Unix systems
| property | default value | allowed values | description |
| username |
|
string |
User to modify the environment for. If empty, the current user will be used |
| value |
|
string |
Variable name |
| name |
|
string |
Environment variable name. |
| scope |
system |
system, user |
Scope. |
Add files to uninstaller.
| property | default value | allowed values | description |
| matchHiddenFiles |
0 |
0, 1 |
Whether or not to attempt to match Windows hidden files |
| excludeFiles |
|
string |
Patterns to exclude files |
| files |
|
string |
File patterns to apply action to |
Add fonts to the Windows system
| property | default value | allowed values | description |
| matchHiddenFiles |
0 |
0, 1 |
Whether or not to attempt to match Windows hidden files |
| excludeFiles |
|
string |
Patterns to exclude files |
| files |
|
string |
File patterns to apply action to |
Add a group to the system. Equal to the Unix 'groupadd' command
| property | default value | allowed values | description |
| showMessageOnError |
0 |
0, 1 |
Whether or not to show an error message when an error occurs. |
| groupname |
|
string |
Group to add to the system |
| abortOnError |
0 |
0, 1 |
Whether or not to abort the installation on an error while executing the action. |
Add a supplementary group to a user. This way, the user is also member of that group. Make sure that the group already exists. If no username is given, then the current logged on user is selected.
| property | default value | allowed values | description |
|
| groupname |
|
string |
Groupname |
Add a path in which the system will search for shared libraries on Linux
| property | default value | allowed values | description |
| path |
|
string |
Path to add to the system search for dynamic libraries on Linux |
Create a new task or modify the value of an existing one.
| property | default value | allowed values | description |
| type |
DAILY |
DAILY, WEEKLY, ONCE, ONIDLE, ONSTART, ONLOGON, MONTHLY |
Type of the Task. |
| runAsAdmin |
0 |
0, 1 |
Run with highest privileges. |
| executionTimeLimit |
72 |
string |
Maximum execution time in hours |
| password |
|
string |
The user password associated with the account specified in runAs parameter. |
| weekDays |
* |
string |
Specifies days to run the task on (MON, TUE, ... SUN) or * for all days of week |
| startTime |
|
|
(hours:minutes) The time the Task becomes activated. |
| runOnlyIfLoggedOn |
0 |
0, 1 |
Run task only if the user specified by runAs parameter is logged on. |
| endDate |
|
|
(year-month-day) Specify the date on which the task becomes inactive. |
| interval |
|
|
(minutes) How often do you want to execute the given Task in specified duration time. |
| program |
|
|
Path to program or script to run. |
| dayOfMonth |
1 |
|
This parameter is used only for Task of MONTHLY type. It specifies the day of the month the task will be executed. |
| name |
|
string |
Name of the Task |
| runAs |
|
string |
Run the Task as the specified user. |
| period |
1 |
|
This parameter is used only for Task of DAILY/WEEKLY type. It specifies how often (every PERIOD days for type DAILY / every PERIOD weeks for type WEEKLY) the task will be executed. |
| startDate |
|
|
(year-month-day) Specify the date on which the task becomes activated. |
| disallowStartIfOnBatteries |
1 |
0, 1 |
Don't start the task if the system is running on batteries |
| workingDirectory |
|
|
Working directory. This is important for scripts that expect to be run from a specific location. By default, it will be the directory where the script or program is located. |
| duration |
|
|
(minutes) How long the Task is active. |
| programArguments |
|
string |
Program arguments. |
Increment the reference count for a shared DLL.
| property | default value | allowed values | description |
| path |
|
string |
Path to the shared DLL |
Append text to a file. If the file does not exist, it will be created.
| property | default value | allowed values | description |
| file |
|
string |
Path to the file |
|
| insertAt |
end |
end, beginning |
Whether to insert the text at the beginning or at the end of the file |
| endOfLineConversion |
auto |
auto, none, cr, crlf, lf |
End Of Line Conversion |
| encoding |
iso8859-1 |
iso8859-1, iso8859-2, utf-8, cp1251, cp1252, ascii, macRoman, unicode, default, binary |
Encoding of the text file |
Adds a program to be executed whenever a window manager session starts (only Linux KDE/Gnome supported).
| property | default value | allowed values | description |
| username |
${system_username} |
string |
User to add the Startup item for. If empty, the current user will be used |
| program |
|
string |
Path to the program to be executed when the session starts. |
| description |
|
string |
The description of the program. |
| name |
|
string |
The name of this startup item. |
| programArguments |
|
string |
Arguments to be considered when running the program (only available for GNOME). |
This action allows you to create a new service in a Linux based system. Note that you will need to run the installer as root to be able to create new services.
| property | default value | allowed values | description |
| program |
|
string |
Path to the program |
| description |
Product description |
string |
Product description |
| name |
${product_shortname} |
string |
Service Name |
Add a user to the system.
| property | default value | allowed values | description |
| username |
|
string |
Username to add to the system |
| homedir |
|
|
Path to the users homedir |
| showMessageOnError |
0 |
0, 1 |
Whether or not to show an error message when an error occurs. |
| password |
|
string |
Password for the user account. |
| abortOnError |
0 |
0, 1 |
Whether or not to abort the installation on an error while executing the action. |
Add rights to user or group on Windows
| property | default value | allowed values | description |
| rights |
|
string |
Account rights, separated by spaces; Example value: SeServiceLogonRight. A complete list can be obtained from http://msdn.microsoft.com/en-us/library/aa375728(v=VS.85).aspx |
| account |
|
string |
User or group name |
Define the set of actions (commands) that can be performed for the given file types.
| property | default value | allowed values | description |
| extensions |
|
string |
Space-separated list of extensions for which the given commands will be available. |
| progID |
|
string |
Programmatic Identifier to which the extensions are attached, contains the available commands to be invoked on each file type. |
| icon |
|
string |
Path to the icon file that contains the icon to display. |
| scope |
system |
user, system |
Choose between system or user scope when installing the association |
| mimeType |
|
string |
MIME type associated to all the file extensions. |
| friendlyName |
|
string |
Friendly Name for the progID. |
| commandList |
|
string |
List of commands that can be invoked on each given file type. |
Autodetects an existing .NET (tm) installation in the system and creates corresponding installer variables: dotnet_version. If a valid .NET framework version was found, the variable dotnet_autodetected, will be set to 1
| property | default value | allowed values | description |
| validDotNetVersionList |
|
string |
List of supported .NET versions |
Autodetects an existing Java (tm) installation in the system and creates corresponding installer variables: java_executable java_vendor java_version java_version_major java_version_full java_bitness. If a valid java version was found, the variable java_autodetected will be set to 1
| property | default value | allowed values | description |
| promptUser |
0 |
0, 1 |
Prompt user to choose appropriate version |
| validVersionList |
|
string |
List of supported Java versions |
| selectionOrder |
first |
first, oldest, newest |
Order of the Java versions detected |
Break current loop
| property | default value | allowed values | description |
Change resource information of a Windows executable
| property | default value | allowed values | description |
| windowsResourceProductName |
|
string |
Product Name for resources embedded in Windows executable |
| windowsResourceOriginalFilename |
|
string |
Original Filename for resources embedded in Windows executable |
| windowsResourceLegalCopyright |
|
string |
Legal Copyright for resources embedded in Windows executable |
| windowsResourceInternalName |
|
string |
Internal Name for resources embedded in Windows executable |
| windowsResourceFileVersion |
|
string |
File version for resources embedded in Windows executable |
| windowsResourceComments |
|
string |
Comments for resources embedded in Windows executable |
| path |
|
string |
Path to the Windows executable to modify |
| windowsResourceProductVersion |
|
string |
Product Version for resources embedded in Windows executable |
| windowsResourceLegalTrademarks |
|
string |
Legal Trademarks for resources embedded in Windows executable |
| windowsResourceFileDescription |
|
string |
File Description for resources embedded in Windows executable |
| windowsResourceCompanyName |
|
string |
Company Name for resources embedded in Windows executable |
Change OSX attributes of a file or directory. Trying to set an attribute on a read only file will result in a failure. Make sure the file is writable before attempting to change any attribute other than, of course, readOnly
| property | default value | allowed values | description |
| hidden |
unchanged |
1, 0, unchanged |
Whether the file is visible or not |
| creator |
|
string |
Creator to set to file or directory |
| excludeFiles |
|
string |
Patterns to exclude files |
| type |
|
string |
Type to set to file or directory |
| readOnly |
unchanged |
1, 0, unchanged |
Whether the file is read only or writable |
| files |
|
string |
File patterns to apply action to |
Change the owner and group of a file or directory
| property | default value | allowed values | description |
| group |
|
string |
Group to set to file or directory |
| excludeFiles |
|
string |
Patterns to exclude files |
| owner |
|
string |
Owner to set to file or directory |
| files |
|
string |
File patterns to apply action to |
Change permissions of a file or directory
| property | default value | allowed values | description |
| permissions |
|
string |
Permissions to set to file or directory |
| excludeFiles |
|
string |
Patterns to exclude files |
| files |
|
string |
File patterns to apply action to |
Change Windows attributes for a file or directory.
| property | default value | allowed values | description |
| matchHiddenFiles |
0 |
0, 1 |
Whether or not to attempt to match Windows hidden files |
| hidden |
unchanged |
1, 0, unchanged |
Whether the file is visible or not |
| system |
unchanged |
1, 0, unchanged |
Whether the file is a System file or a regular one |
| excludeFiles |
|
string |
Patterns to exclude files |
| readOnly |
unchanged |
1, 0, unchanged |
Whether the file is read only or writable |
| archive |
unchanged |
1, 0, unchanged |
Whether the file has or has not changed since the last backup. |
| files |
|
string |
File patterns to apply action to |
| abortOnError |
0 |
0, 1 |
Whether or not to abort the installation on an error while executing the action. |
Clear Windows ACL permissions of a file or directory
| property | default value | allowed values | description |
| matchHiddenFiles |
0 |
0, 1 |
Whether or not to attempt to match Windows hidden files |
| excludeFiles |
|
string |
Patterns to exclude files |
| files |
|
string |
File patterns to apply action to |
Select or deselect components for installation.
| property | default value | allowed values | description |
| select |
|
string |
Comma separated list of components you wish to select for installation. |
| deselect |
|
string |
Comma separated list of components you wish to deselect for installation. |
Write text to console
| property | default value | allowed values | description |
|
Continue current loop
| property | default value | allowed values | description |
Create a copy of a file. The destination file will be overwritten if it already exists
| property | default value | allowed values | description |
| origin |
|
string |
Path to the original file. |
| matchHiddenFiles |
0 |
0, 1 |
Whether or not to attempt to match Windows hidden files |
| excludeFiles |
|
string |
Patterns to exclude files |
| destination |
|
string |
Path to where the file will be copied. |
Create a backup of a file or directory. The backup will be named with a .bak extension if no destination is specified. If a backup file already exists, new backups will be named .bak1, .bak2 and so on.
| property | default value | allowed values | description |
| path |
|
string |
Path to original file you wish to backup. |
| destination |
|
string |
Path to the destination backup folder. |
Create a new directory
| property | default value | allowed values | description |
| path |
|
|
Path to the new directory |
Creates one or more Java launchers in specified location.
| property | default value | allowed values | description |
| javaLauncherList |
|
string |
List of launchers to create. |
| destination |
|
string |
Path to the location where you want to create the launchers. |
Create Mac OS X service.
| property | default value | allowed values | description |
|
| program |
|
string |
Path to program |
| serviceName |
|
string |
Identifier for the service name |
| scope |
user |
user, system |
Scope of service |
| programArguments |
|
string |
Arguments to pass to the program |
| keepAlive |
1 |
0, 1 |
Keep process alive by launchctl |
| groupname |
|
string |
Groupname |
Creates one or more shortcuts in specified location.
| property | default value | allowed values | description |
| shortcutList |
|
string |
List of shortcuts to create. |
| destination |
|
string |
Path to the location where you want to create the shortcuts. |
Create a symbolic link to a file. It is the equivalent to the Unix 'ln' command.
| property | default value | allowed values | description |
| target |
|
string |
Path to the file to which you want to create a symbolic link. |
| linkName |
|
string |
Symbolic link name. |
This action allows you to create a timestamp using a custom format, storing the result in an installer variable.
| property | default value | allowed values | description |
| format |
%Y%m%d |
string |
Format string for the generated timestamp. The string allows a number of field descriptors. |
| variable |
|
string |
Variable that will store the resulting timestamp. |
Register a program as a Windows service.
| property | default value | allowed values | description |
| startType |
auto |
auto, manual, disabled |
Specify how the service should be started |
| program |
|
string |
Path to program |
| description |
|
string |
Program description |
| account |
|
string |
User account under which the service should run. It takes the form domain\username. If the account is a local account, it may be specified as .\username or username. If this option is not specified, the service will run under the LocalSystem account. |
| serviceName |
|
string |
Internal service name |
| programArguments |
|
string |
Arguments to pass to the program |
| password |
|
string |
Password for the user account if one is specified. |
| displayName |
|
string |
Name displayed in the Windows service control panel |
| dependencies |
|
string |
Comma separated list of services that the created service depends on |
| abortOnError |
0 |
0, 1 |
Whether or not to abort the installation on an error while executing the action. |
Decode a string using base64.
| property | default value | allowed values | description |
| text |
|
string |
Text to process |
| variable |
|
string |
Variable to save the final result to. |
Delete an environment variable from the system.
| property | default value | allowed values | description |
| username |
|
string |
User to modify the environment for. If empty, the current user will be used |
| name |
|
string |
Environment variable name. |
| scope |
system |
system, user |
Scope. |
Delete a file. The action does not throw an error if deleting a file or directory failed.
| property | default value | allowed values | description |
| matchHiddenFiles |
0 |
0, 1 |
Whether or not to attempt to match Windows hidden files |
| path |
|
string |
Path to the file or directory to delete. It accepts patterns |
| excludeFiles |
|
string |
Patterns to exclude files |
Delete a group from the system. Equivalent to the Unix 'groupdel' command
| property | default value | allowed values | description |
| showMessageOnError |
0 |
0, 1 |
Whether or not to show an error message when an error occurs. |
| groupname |
|
string |
Group name to delete. |
| abortOnError |
0 |
0, 1 |
Whether or not to abort the installation on an error while executing the action. |
Delete a supplementary group from a user.
| property | default value | allowed values | description |
|
| groupname |
|
string |
Groupname |
Delete Mac OS X service.
| property | default value | allowed values | description |
| serviceName |
|
string |
Identifier for the service name |
| scope |
user |
user, system |
Scope of service |
Delete Windows Scheduled Task
| property | default value | allowed values | description |
| name |
|
string |
Name of the Task |
Delete a user from the system. Equivalent to the Unix 'userdel' command
| property | default value | allowed values | description |
|
| showMessageOnError |
0 |
0, 1 |
Whether or not to show an error message when an error occurs. |
| abortOnError |
0 |
0, 1 |
Whether or not to abort the installation on an error while executing the action. |
Delete a Windows service
| property | default value | allowed values | description |
| serviceName |
|
string |
Internal service name |
| displayName |
|
string |
Name displayed in the Windows service control panel |
| abortOnError |
0 |
0, 1 |
Whether or not to abort the installation on an error while executing the action. |
Returns a name comprised of all of the path components in name excluding the last element. If name is a relative file name and only contains one path element, then returns ".". If name refers to a root directory, then the root directory is returned.
| property | default value | allowed values | description |
| path |
|
string |
The path from which the base directory will be retrieved. |
| variable |
|
string |
Variable that will store the directory path. |
Convert plain text files in DOS/Mac format to Unix format.
| property | default value | allowed values | description |
| matchHiddenFiles |
0 |
0, 1 |
Whether or not to attempt to match Windows hidden files |
| excludeFiles |
|
string |
Patterns to exclude files |
| files |
|
string |
File patterns to apply action to |
Encode a string using base64.
| property | default value | allowed values | description |
| text |
|
string |
Text to process |
| variable |
|
string |
Variable to save the final result to. |
Exit the installer/uninstaller.
| property | default value | allowed values | description |
| exitCode |
0 |
|
exit code returned by the installer/uninstaller |
Search for a file in a directory and all the subdirectories.
| property | default value | allowed values | description |
| baseDirectory |
|
|
Path to the directory in which to search for the file. It will search inside the directory and all of its subdirectories. |
| followSymLinks |
0 |
0, 1 |
Whether or not to follow or not symbolic links |
| variable |
|
string |
Variable where the full path to the first matching file will be stored |
| pattern |
|
string |
Pattern for the file that will be searched. The pattern can contain wildcards (*,?). |
Iterate over a set of values
| property | default value | allowed values | description |
| values |
|
string |
Space-separated values to iterate over |
| variables |
|
string |
Space-separated list of variables that will be assigned a value with each iteration |
| actionList |
|
string |
List of actions |
Generate a random value.
| property | default value | allowed values | description |
| variable |
|
string |
Variable to which to save the generated value. |
| length |
32 |
|
Character length for the generated value. |
Gets Information About File Or Directory
| property | default value | allowed values | description |
|
| followSymLinks |
0 |
0, 1 |
Whether or not to follow or not symbolic links |
| variable |
|
string |
Variable to store result in |
| type |
size |
size, type |
Type of information to retrieve |
Calculate the free disk (KiloBytes) space and save the value in the given variable. Returns -1 if free space cannot be determined.
| property | default value | allowed values | description |
| path |
|
|
Path to the folder or disk |
| variable |
|
string |
Variable to which to save the result of the calculation |
| units |
KB |
KB, MB, GB |
Size units for the returned value. |
Returns the number of the first available port in a range of port numbers specified by initialPort and finalPort (both inclusive).
| property | default value | allowed values | description |
| variable |
|
string |
Variable that will store the free port number. |
| initialPort |
|
string |
The initial port number on the range (inclusive). |
| finalPort |
|
string |
The final port number on the range (inclusive). |
Get permissions of a file or directory
| property | default value | allowed values | description |
| file |
|
string |
File or directory to retrieve permissions |
| variable |
permissions |
string |
Variable name to save permissions |
Gets Name Of Process Using Specified Port
| property | default value | allowed values | description |
| port |
|
string |
TCP port to check |
| variable |
|
string |
Variable to use for storing name of the process using the port |
| pidVariable |
|
string |
Variable to use for storing id of the process using the port |
Get the destination path referenced by the given symbolic link. Returns an empty value if the file doesn't exist or is not a symbolic link.
| property | default value | allowed values | description |
| variable |
|
string |
Variable to store result |
| link |
|
string |
Symbolic link path |
Get the total disk (KiloBytes) space and save the value in the given variable. Returns -1 if total space cannot be determined.
| property | default value | allowed values | description |
| path |
|
|
Path to the folder or disk |
| variable |
|
string |
Variable to which to save the result of the calculation |
| units |
KB |
KB, MB, GB |
Size units for the returned value. |
Return a unique service name
| property | default value | allowed values | description |
| selectedServiceNameVariable |
|
string |
Variable to store the Service name |
| serviceName |
|
string |
Initial name for the service |
| selectedDisplayNameVariable |
|
string |
Variable to store the service display name |
| displayName |
|
string |
Initial display name for the service |
Get Windows ACL permissions of a file or directory
| property | default value | allowed values | description |
| username |
|
string |
User to retrieve ACL |
| file |
|
string |
File to retrieve ACL |
| grantedPermissions |
granted |
string |
Variable name to save granted permissions |
| deniedPermissions |
denied |
string |
Variable name to save denied permissions |
Get file information.
| property | default value | allowed values | description |
| path |
|
string |
Path to the file |
| variable |
|
string |
Variable to save the file info to |
| type |
|
codepage, flags, os, productversion, signature, structversion, type, version |
Type of the file info. |
Mark a list of variables as global. Global variables defined or modified inside custom actions preserve their values after the execution while regular variables are not visible outside.
| property | default value | allowed values | description |
| names |
|
string |
Variable names |
Access a URL and save the result into a file.
| property | default value | allowed values | description |
| username |
|
string |
Username for URLs that require authentication |
| filename |
|
string |
Filename to which to save the result to |
|
| password |
|
string |
Password for URLs that require authentication |
Access a URL using HTTP POST and save the result into a file.
| property | default value | allowed values | description |
| username |
|
string |
Username for URLs that require authentication |
| filename |
|
string |
Filename to which to save the result to |
| queryParameterList |
|
string |
List of variables that will be included in the POST query. |
|
| password |
|
string |
Password for URLs that require authentication |
Configure proxy to be used by http actions
| property | default value | allowed values | description |
| username |
|
string |
Proxy server username |
| port |
|
string |
Proxy server port |
| exclude |
127.0.0.1 |
string |
Space separated list of patters for urls that will be excluded from the proxy configuration |
| server |
|
string |
Proxy server url |
| password |
|
string |
Proxy server password |
Conditionally execute a group of actions
| property | default value | allowed values | description |
| conditionRuleEvaluationLogic |
and |
and, or |
Condition rule evaluation logic |
| actionList |
|
string |
List of actions to execute if condition is true |
| elseActionList |
|
string |
List of actions to execute if condition is false |
| conditionRuleList |
|
string |
List of conditions |
Extract property values out of a INI file.
| property | default value | allowed values | description |
| file |
|
string |
Path to INI file |
| section |
|
string |
INI section |
|
| variable |
|
string |
Variable name to save property to |
Set property values of a INI file.
| property | default value | allowed values | description |
| file |
|
string |
Path to INI file |
| value |
|
string |
Property Value |
| section |
|
string |
INI section |
|
This action allows you to kill a running process that matches one or several conditions. Windows support only.
| property | default value | allowed values | description |
| pid |
|
string |
ID of the process to be killed. |
| path |
|
string |
Path to the executable of the process. |
| name |
|
string |
Name of the process, usually the executable filename. |
Launch the default web browser with a given URL.
| property | default value | allowed values | description |
| url |
|
string |
URL of the page to be shown. |
Based on command given, locates binary and creates command that needs to be run.
| property | default value | allowed values | description |
| variable |
|
string |
Variable to store the result in |
| command |
|
string |
Command to locate |
Write a message to the installation log. Useful for debugging purposes.
| property | default value | allowed values | description |
| timeStampFormat |
[%H:%M:%S] |
string |
Format string for the optional timestamp. The string allows a number of field descriptors. |
| text |
|
|
Message to include in log |
| enableTimeStamp |
1 |
0, 1 |
Whether to enable timestamp in the message or not. |
Calculate math expression
| property | default value | allowed values | description |
|
| variable |
|
string |
Variable to save the final result to. |
Generate a MD4 from a given text.
| property | default value | allowed values | description |
| useNTLMFormat |
1 |
0, 1 |
Whether or not to create an NTLM compilant hash |
| text |
|
|
Text to calculate the MD4 on. |
| variable |
|
string |
Variable to which to save the MD4 to. |
Generate a MD5 from a given text.
| property | default value | allowed values | description |
| text |
|
|
Text to calculate the MD5 on. |
| variable |
|
string |
Variable to which to save the MD5 to. |
Performs change on the path and returns it in variable
| property | default value | allowed values | description |
| path |
|
string |
The path to manipulate |
| variable |
|
string |
Variable that will store the new path. |
| action |
absolutize |
absolutize |
Action to perform on the path |
Extract property values out of a properties file.
| property | default value | allowed values | description |
| file |
|
string |
Path to the property file |
|
| variable |
|
string |
Variable name to save property to |
| endOfLineConversion |
auto |
auto, none, cr, crlf, lf |
End Of Line Conversion |
| encoding |
default |
iso8859-1, iso8859-2, utf-8, cp1251, cp1252, ascii, macRoman, unicode, default, binary |
Encoding of the text file |
Writes out property values to a properties file, creating a new file if it does not exist.
| property | default value | allowed values | description |
| file |
|
string |
Path to the property file |
| value |
|
string |
Value to set the key to. |
|
| endOfLineConversion |
auto |
auto, none, cr, crlf, lf |
End Of Line Conversion |
| encoding |
default |
iso8859-1, iso8859-2, utf-8, cp1251, cp1252, ascii, macRoman, unicode, default, binary |
Encoding of the text file |
Read the contents of a file and save it in a variable.
| property | default value | allowed values | description |
| removeBOM |
0 |
0, 1 |
Whether or not to remove or not Byte Order Mark on Unicode files |
| path |
|
string |
Path to the file you wish to read the contents from |
| name |
|
string |
Variable to which to save the file contents |
| endOfLineConversion |
auto |
auto, none, cr, crlf, lf |
End Of Line Conversion |
| encoding |
iso8859-1 |
iso8859-1, iso8859-2, utf-8, cp1251, cp1252, ascii, macRoman, unicode, default, binary |
Encoding of the text file |
Delete a registry entry. If the entry to delete is only a registry key and it does not exist, the action will be ignored. Deleting a registry value (key + name combination) that does not exist will trigger a regular error.
| property | default value | allowed values | description |
| name |
|
string |
Entry name to delete |
|
| wowMode |
none |
none, 32, 64 |
Determines whether we want to access a 32-bit or 64-bit view of the Registry |
Retrieve the first registry hive and content matching a certain expression and store it as a list in an installer variable. If no match is found the variable will be created empty.
| property | default value | allowed values | description |
| dataPattern |
* |
string |
Pattern to match in the value |
| rootKey |
HKEY_LOCAL_MACHINE\SOFTWARE |
string |
Root key from which start the search |
| wowMode |
none |
none, 32, 64 |
Determines whether we want to access a 32-bit or 64-bit view of the Registry |
| variable |
|
string |
Variable name to store the results |
| findAll |
0 |
0, 1 |
Whether to look for the first occurrence or for all |
| searchDepth |
0 |
|
Maximum depth of the search. 0 will look just in the Root Key |
| namePattern |
* |
string |
Pattern to match entry name with |
| keyPattern |
* |
string |
Pattern to match key name with |
Store the value of a registry key in an installer variable. If the key or name does not exist, then the variable will be created empty.
| property | default value | allowed values | description |
| name |
|
string |
Entry name to read value from |
|
| wowMode |
none |
none, 32, 64 |
Determines whether we want to access a 32-bit or 64-bit view of the Registry |
| variable |
|
string |
Variable name to store registry value to |
Store in 'variable' the first registry key that matches the given pattern, or set the variable to empty otherwise. The search is case-sensitive for the whole key provided.
| property | default value | allowed values | description |
|
| wowMode |
none |
none, 32, 64 |
Determines whether we want to access a 32-bit or 64-bit view of the Registry |
| variable |
|
string |
Variable to store result |
Store the value of the first match of a registry key matching a certain expression in an installer variable. If the key or name does not exist, then the variable will be created empty. The name can contain a wildcard expression (using *)
| property | default value | allowed values | description |
| name |
|
string |
Entry name to read value from |
|
| wowMode |
none |
none, 32, 64 |
Determines whether we want to access a 32-bit or 64-bit view of the Registry |
| variable |
|
string |
Variable name to store registry value to |
Create a new registry key or modify the value of an existing registry key.
| property | default value | allowed values | description |
| value |
|
string |
Value to set to the registry key |
| name |
|
string |
Entry name to set or modify value to |
|
| wowMode |
none |
none, 32, 64 |
Determines whether we want to access a 32-bit or 64-bit view of the Registry |
| type |
REG_SZ |
REG_BINARY, REG_NONE, REG_SZ, REG_EXPAND_SZ, REG_DWORD, REG_BIG_ENDIAN, REG_LINK, REG_MULTI_SZ, REG_RESOURCE_LIST |
Type of key to add |
Clear choice values for a parameter
| property | default value | allowed values | description |
| options |
|
string |
Options to remove |
| name |
|
string |
Name of an existing choice parameter. |
Remove a directory from the System Path. This will modify the System Path
| property | default value | allowed values | description |
| path |
|
|
Path to the directory |
| scope |
system |
system, user |
Select user path or system path. |
Remove files or directories from uninstaller.
| property | default value | allowed values | description |
| matchHiddenFiles |
0 |
0, 1 |
Whether or not to attempt to match Windows hidden files |
| excludeFiles |
|
string |
Patterns to exclude files |
| files |
|
string |
File patterns to apply action to |
Remove fonts from the Windows system
| property | default value | allowed values | description |
| matchHiddenFiles |
0 |
0, 1 |
Whether or not to attempt to match Windows hidden files |
| excludeFiles |
|
string |
Patterns to exclude files |
| files |
|
string |
File patterns to apply action to |
Decrements the reference count for a shared DLL. If it reaches zero, the file will be removed
| property | default value | allowed values | description |
| path |
|
string |
Path to the shared DLL |
This action allows you to remove a service in a Linux based system. Note that you will need to run the installer as root to be able to remove services.
| property | default value | allowed values | description |
| name |
${product_shortname} |
string |
Service Name |
Remove rights from user or group on Windows
| property | default value | allowed values | description |
| rights |
|
string |
Account rights, separated by spaces; Example value: SeServiceLogonRight. A complete list can be obtained from http://msdn.microsoft.com/en-us/library/aa375728(v=VS.85).aspx |
| account |
|
string |
User or group name |
Unregisters the associations between the given file types and any set of actions (commands) that may be defined on them.
| property | default value | allowed values | description |
| extensions |
|
string |
Space-separated list of extensions to remove. |
| progID |
|
string |
Programmatic Identifier to remove, to which the extensions are attached. |
| scope |
system |
user, system |
Choose between system or user scope when installing the association |
| mimeType |
|
string |
MIME type to remove, associated to all the file extensions. It must be specified if you want to delete MIME associations added previously with associateWindowsFileExtension action. |
Change the name of a file or directory
| property | default value | allowed values | description |
| origin |
|
string |
Original name of the file. |
| matchHiddenFiles |
0 |
0, 1 |
Whether or not to attempt to match Windows hidden files |
| excludeFiles |
|
string |
Patterns to exclude files |
| destination |
|
string |
New name of the file. |
Restart a Windows service
| property | default value | allowed values | description |
| serviceName |
|
string |
Internal service name |
| displayName |
|
string |
Name displayed in the Windows service control panel |
| delay |
15000 |
|
Amount of milliseconds to wait for the service to start / stop. |
| abortOnError |
0 |
0, 1 |
Whether or not to abort the installation on an error while executing the action. |
Run a program or script
| property | default value | allowed values | description |
| useMSDOSPath |
1 |
0, 1 |
Whether or not to use or not MSDOS program name path on Windows |
| program |
|
string |
Path to program or script to run |
| runAs |
|
string |
Run the program or script as a specific user id. It will only take effect on Unix system and when running the installer as root |
| workingDirectory |
|
string |
Working directory. This is important for scripts that expect to be run from a specific location. By default, it will be the directory where the script or program is located |
| stdin |
|
|
Text to send to program's standard input. |
| programArguments |
|
string |
Program arguments |
Specifies and verifies password to use for copying files from installer
| property | default value | allowed values | description |
| password |
|
string |
Password to use; action will throw error if password specified does not match password from build time |
Set the value of a system environment variable. If it does not exist yet, a new one will be created. The variable will not exist once the installer has finished.
| property | default value | allowed values | description |
| value |
|
string |
Variable value |
| name |
|
string |
Variable name |
Set a installer variable. If the name of the variable matches a parameter name, the value of the parameter will be updated.
| property | default value | allowed values | description |
| value |
|
|
Value to set the variable to |
| name |
|
string |
Variable name |
| persist |
0 |
0, 1 |
Whether the variable will be available in the uninstaller as well. |
Set a installer variable to the result of a regular expression. If the name of the variable matches a parameter name, the value of the parameter will be updated.
| property | default value | allowed values | description |
|
| substitution |
|
string |
Value to replace matched text with |
| name |
|
string |
Name of the variable to set |
| pattern |
|
string |
Pattern to match |
Set a installer variable to the output of a script. If the name of the variable matches a parameter name, the value of the parameter will be updated.
| property | default value | allowed values | description |
| name |
|
string |
Name of the variable to set |
| exec |
|
string |
Path to the script to run |
| workingDirectory |
|
string |
Working directory. This is important for scripts that expect to be run from a specific location |
| execArgs |
|
string |
Arguments to pass to the script |
Change Windows ACL permissions of a file or directory
| property | default value | allowed values | description |
| permissions |
generic_all |
string |
Permissions for matching files or directories |
| matchHiddenFiles |
0 |
0, 1 |
Whether or not to attempt to match Windows hidden files |
| recurseOneLevelOnly |
0 |
0, 1 |
Just one level recursion if applicable |
| excludeFiles |
|
string |
Patterns to exclude files |
| users |
S-1-1-0 |
string |
Comma separated list of users to modify access permissions for |
| self |
1 |
0, 1 |
Whether to apply or not to the specified file |
| action |
allow |
allow, deny |
Whether to allow or deny permissions |
| recurseObjects |
0 |
0, 1 |
Whether to apply recursively or not to object descendant |
| recurseContainers |
0 |
0, 1 |
Whether to apply recursively or not to container descendant |
| files |
|
string |
File patterns to apply action to |
Generate a SHA-1 from a given text.
| property | default value | allowed values | description |
| text |
|
|
Text to calculate the SHA-1 on. |
| variable |
|
string |
Variable to which to save the SHA-1 to. |
Generate a SHA-256 from a given text.
| property | default value | allowed values | description |
| text |
|
|
Text to calculate the SHA-256 on. |
| variable |
|
string |
Variable to which to save the SHA-256 to. |
Prompt a choice question dialog to the user.
| property | default value | allowed values | description |
| optionList |
|
string |
Predefined list of options that allows the user to select a value |
| text |
|
|
Information message that will be shown |
| variable |
|
string |
Variable to store choice |
| title |
Choose an option |
string |
Dialog title |
| defaultValue |
|
string |
Default value |
Prompt an info dialog to the user.
| property | default value | allowed values | description |
| text |
|
|
Information message that will be shown |
| title |
${msg(MessageDialog.Info)} |
string |
Title of the dialog window |
Ask the user to enter a password.
| property | default value | allowed values | description |
| text |
|
|
Question message that will be shown. |
| variable |
|
string |
Variable name where the password will be stored. |
| title |
|
string |
Dialog window title. |
Display an indeterminate progressmeter in a popup window to execute a list of actions.
| property | default value | allowed values | description |
| width |
300 |
|
Popup window width |
| height |
100 |
|
Popup window height |
| actionList |
|
string |
Actions to Execute |
| title |
|
string |
Title of the progress dialog window |
Prompt a question to the user. The result is stored as 'yes' or 'no' in the given variable name.
| property | default value | allowed values | description |
| text |
|
|
Question message that will be shown. |
| default |
yes |
yes, no |
Default answer, it can be yes or no. |
| variable |
|
string |
Variable name where the result will be stored |
| title |
${msg(MessageDialog.Question)} |
string |
Title of the dialog window |
Ask the user a question.
| property | default value | allowed values | description |
| text |
|
string |
Question message that will be shown. |
| variable |
|
string |
Variable name where the answer will be stored. |
| title |
|
string |
Dialog window title. |
Display a read-only text dialog to the user.
| property | default value | allowed values | description |
| width |
500 |
|
Text window width |
| text |
|
|
Text that will be shown. |
| height |
600 |
|
Text window height |
| title |
|
string |
Dialog title. |
| htmlText |
|
|
HTML text that will be shown in Qt mode. Note that regular text still needs to be provided in case the installer is run in another mode |
Shows a warning dialog with the given text.
| property | default value | allowed values | description |
| text |
Warning message goes here |
|
Warning message that will be shown. |
| title |
${msg(MessageDialog.Warning)} |
string |
Title of the dialog window |
Shut down the machine (Windows only)
| property | default value | allowed values | description |
| delay |
|
|
Delay in seconds before shut down. |
Start Mac OS X service.
| property | default value | allowed values | description |
| serviceName |
|
string |
Identifier for the service name |
Start a Windows service
| property | default value | allowed values | description |
| serviceName |
|
string |
Internal service name |
| displayName |
|
string |
Name displayed in the Windows service control panel |
| delay |
15000 |
|
Amount of milliseconds to wait for the service to start. |
| abortOnError |
0 |
0, 1 |
Whether or not to abort the installation on an error while executing the action. |
Stop Mac OS X service.
| property | default value | allowed values | description |
| serviceName |
|
string |
Identifier for the service name |
Stop a Windows service
| property | default value | allowed values | description |
| serviceName |
|
string |
Internal service name |
| displayName |
|
string |
Name displayed in the Windows service control panel |
| delay |
15000 |
|
Amount of milliseconds to wait for the service to stop. |
| abortOnError |
0 |
0, 1 |
Whether or not to abort the installation on an error while executing the action. |
Perform one of the allowed transformations in the specified text, storing the result into a variable.
| property | default value | allowed values | description |
| text |
|
|
Text which will be transformed. |
| variable |
|
string |
Variable name which will store the result. |
| logic |
trim |
toupper, tolower, totitle, trimleft, trimright, trim |
Transformation to perform. |
Substitute a value in a file.
| property | default value | allowed values | description |
| matchHiddenFiles |
0 |
0, 1 |
Whether or not to attempt to match Windows hidden files |
| substitutionList |
|
string |
List of patterns/values for a substitution |
| excludeFiles |
|
string |
Patterns to exclude files |
| type |
regexp |
regexp, exact |
Type of substitution, regular expression or exact |
| files |
|
string |
File patterns to apply action to |
| encoding |
binary |
iso8859-1, iso8859-2, utf-8, cp1251, cp1252, ascii, macRoman, unicode, binary |
Encoding of the files to substitute |
Generate an error inside the installer so the installer will exit. The only exception to this is when abortOnError equals zero or the action is inside a validationActionList, in which case it will prompt an error dialog to the user, but will not exit the installer.
| property | default value | allowed values | description |
| text |
Unknown Error |
|
Error message |
Update the access and modification times of a file or directory. If the file does not exist, it can be specified whether to create an empty file or not. It is equivalent to the 'touch' Unix command.
| property | default value | allowed values | description |
| matchHiddenFiles |
0 |
0, 1 |
Whether or not to attempt to match Windows hidden files |
| createIfNotExists |
1 |
0, 1 |
Whether or not to create the file in case it does not exist |
| path |
|
string |
Path to the file/directory to be touched |
Convert plain text files in Unix format to DOS format.
| property | default value | allowed values | description |
| matchHiddenFiles |
0 |
0, 1 |
Whether or not to attempt to match Windows hidden files |
| excludeFiles |
|
string |
Patterns to exclude files |
| files |
|
string |
File patterns to apply action to |
Extract a directory from an installer before files are unpacked during the installation phase
| property | default value | allowed values | description |
| origin |
|
string |
Directory name you want to extract. |
| folder |
|
string |
Project folder name where the directory you want to extract is located. |
| destination |
|
string |
Path to the location where you want to extract the directory. |
| component |
|
string |
Project component where the directory you want to extract is located. |
Extract files from an installer before files are unpacked during the installation phase
| property | default value | allowed values | description |
| origin |
|
string |
File name you want to extract |
| folder |
|
string |
Project folder name where where the file you want to extract is located |
| destination |
|
string |
Path to the location where you want to extract the file |
| component |
|
string |
Project component where the file you want to extract is located |
Extract content from a zip file to a destination folder.
| property | default value | allowed values | description |
| zipFile |
|
string |
ZIP file that will be uncompressed |
| destinationDirectory |
|
string |
Path to the folder where you want the file content to be extracted. The folder must exist and must be writable |
Decode a given text using URL formatting specifications and place the result in a variable.
| property | default value | allowed values | description |
|
| variable |
|
string |
Variable to store the result in |
Encode a given text using URL formatting specifications and place the result in a variable.
| property | default value | allowed values | description |
|
| variable |
|
string |
Variable to store the result in |
Pause the installation for given time
| property | default value | allowed values | description |
| ms |
|
string |
Number of milliseconds to wait |
Pause the installation for a maximum timeout until a server process is listening in the specified port
| property | default value | allowed values | description |
| state |
in_use |
free, in_use |
Wait for port to be free or in use. |
| port |
|
string |
TCP port to check |
| timeout |
|
string |
Maximum amount of time to wait (in milliseconds) |
Execute a group of actions as long as conditions are met
| property | default value | allowed values | description |
| conditionRuleEvaluationLogic |
and |
and, or |
Condition rule evaluation logic |
| actionList |
|
string |
List of actions |
| conditionRuleList |
|
string |
List of conditions |
Modifies the Windows x64 File System Redirection behavior. It mainly redirects %Windir%System32 to %Windir%SysWOW64 for 32-bit processes running on Windows x64 systems. A similar effect is also applied to 'Program Files'
| property | default value | allowed values | description |
| action |
disable |
enable, disable |
Whether to enable or disable the File System Redirection |
Create or replace a file with a certain text content.
| property | default value | allowed values | description |
|
| path |
|
string |
Path of the file to be created or replaced |
| endOfLineConversion |
auto |
auto, none, cr, crlf, lf |
End Of Line Conversion |
| encoding |
default |
iso8859-1, iso8859-2, utf-8, cp1251, cp1252, ascii, macRoman, unicode, default, binary |
Encoding of the text file |
Comment entire subtree of an XML file
| property | default value | allowed values | description |
| file |
|
string |
Path to XML file |
| element |
|
string |
XPath expression pointing to the selected element |
Read value of element or attribute from an XML file
| property | default value | allowed values | description |
| file |
|
string |
Path to XML file |
| attribute |
|
string |
If present, the action will refer to the attribute instead of the element |
| variable |
|
string |
Variable where to start the result |
| element |
|
string |
XPath expression pointing to the selected element |
Set the value of an element or attribute in an XML file
| property | default value | allowed values | description |
| file |
|
string |
Path to XML file |
| attribute |
|
string |
If present, the action will refer to the attribute instead of the element |
| value |
|
string |
Value to store in element or attribute |
| element |
|
string |
XPath expression pointing to the selected element |
Read value of element from a YAML file
| property | default value | allowed values | description |
| file |
|
string |
Path to YAML file |
| variable |
|
string |
Variable where to start the result |
| element |
|
string |
Path expression pointing to the selected element |
Set the value of an element in a YAML file
| property | default value | allowed values | description |
| file |
|
string |
Path to YAML file |
| value |
|
string |
Value to store in element |
| element |
|
string |
Path expression pointing to the selected element |
Pack one or more files to a zip file, relative to base directory.
| property | default value | allowed values | description |
| matchHiddenFiles |
0 |
0, 1 |
Whether or not to attempt to match Windows hidden files |
| baseDirectory |
|
string |
Directory that all files will be packed relatively to |
| excludeFiles |
|
string |
Patterns to exclude files |
| zipFile |
|
string |
ZIP file that will be created |
| files |
|
string |
File patterns to apply action to |
Check whether or not antivirus is set up and running. Only available on Windows platform
| property | default value | allowed values | description |
| product |
any |
any, windows_defender |
Product to test, or any product |
| type |
|
enabled, disabled |
Type of test |
Check whether or not enough free disk space is available
| property | default value | allowed values | description |
| path |
|
|
Path to the folder or disk |
| logic |
|
equals, does_not_equal, greater_or_equal, greater, less, less_or_equal |
Comparison type |
| units |
KB |
KB, MB, GB |
Size units for the checked value. |
| size |
0 |
|
Size of free disk space to check for |
Compare a text with a value.
| property | default value | allowed values | description |
|
|
| nocase |
0 |
0, 1 |
Case insensitive comparison |
| logic |
equals |
equals, contains, does_not_contain, does_not_equal |
Comparison type |
Compare the length of a text.
| property | default value | allowed values | description |
| text |
|
string |
Text to compare the length of |
| logic |
|
equals, does_not_equal, greater_or_equal, greater, less, less_or_equal |
Comparison type |
| length |
|
string |
Length to compare with |
Compare two values with each other.
| property | default value | allowed values | description |
| value1 |
|
string |
First comparison operand |
| logic |
|
equals, does_not_equal, greater_or_equal, greater, less, less_or_equal |
Comparison type |
| value2 |
|
string |
Second comparison operand |
Compare two versions.
| property | default value | allowed values | description |
| version2 |
|
string |
Second comparison operand |
| logic |
|
equals, does_not_equal, greater, greater_or_equal, less, less_or_equal |
Test type |
| version1 |
|
string |
First comparison operand |
Perform check on a given component.
| property | default value | allowed values | description |
| name |
|
string |
Name of the component |
| logic |
exists |
exists, does_not_exist, selected, not_selected, hidden, visible, editable, not_editable |
Comparison type |
Check whether a file contains or does not contain a text.
| property | default value | allowed values | description |
| text |
|
string |
Text to compare with |
| path |
|
string |
Path to file that contains text for comparison |
| logic |
|
contains, does_not_contain |
Test type |
| encoding |
iso8859-1 |
iso8859-1, iso8859-2, utf-8, cp1251, cp1252, ascii, macRoman, unicode, binary |
Encoding of the text file |
Check for the existence of a given directory or file.
| property | default value | allowed values | description |
| path |
|
string |
File or directory path for the test, accepts wildcards. |
Check if file is locked.
| property | default value | allowed values | description |
| path |
|
string |
File or directory path to check |
Perform test on a given directory or file.
| property | default value | allowed values | description |
| path |
|
string |
File or directory path for the test |
| condition |
exists |
exists, not_exists, writable, not_writable, readable, not_readable, executable, not_executable, is_directory, is_not_directory, is_symlink, is_not_symlink, is_file, is_not_file, is_empty, is_not_empty |
Specifies the requirement to test over the given file |
Check whether or not a firewall is set up and running. Only available on Windows platform
| property | default value | allowed values | description |
| type |
|
enabled, disabled |
Type of test |
Validates whether or not a given hostname or IP address meets the given condition
| property | default value | allowed values | description |
| type |
|
ip, ipv6, hostname, any |
Type of host specification |
| host |
|
string |
Hostname or IP address to be checked |
| condition |
|
is_valid, is_not_valid |
A valid host is one that can be resolved to an IP address and a valid IP is one that is syntactically correct |
The rule returns false if 'value' is one of 1, yes or true. Otherwise it evaluates to true.
| property | default value | allowed values | description |
| value |
|
string |
String to test if it is false |
The rule returns true if 'value' is one of 1, yes or true. Otherwise it evaluates to false.
| property | default value | allowed values | description |
| value |
|
string |
String to test if it is true |
Check whether or not a service exists and whether or not it is running. Checking if service exists requires Mac OS X version 10.4 or later. Checking if service is running requires Mac OS X 10.5 or later.
| property | default value | allowed values | description |
| service |
|
string |
Name of service |
| condition |
|
exists, not_exists, is_running, is_not_running |
Condition to test for |
Compare the system platform with a given platform name.
| property | default value | allowed values | description |
| type |
|
aix, freebsd, freebsd4, freebsd6, freebsd6-x64, freebsd7, freebsd7-x64, hpux, hpux-ia64, hpux-parisc, irix-n32, linux, linux-ia64, linux-ppc, linux-s390, linux-s390x, linux-x64, linux-x86, openbsd, openbsd3, osx, osx-intel, osx-ppc, solaris, solaris-intel, solaris-sparc, unix, windows, windows-2000, windows-2003, windows-2008, windows-2008-r2, windows-2012, windows-2012-r2, windows-7, windows-8, windows-8.1, windows-9x, windows-nt, windows-vista, windows-x64, windows-x86, windows-xp |
Type of platform to test for |
Allows you to test whether a port is free in the local machine.
| property | default value | allowed values | description |
| port |
|
string |
A port number |
| condition |
|
can_bind, cannot_bind |
Condition to test for |
Check if a particular process exists in the system. Currently only supported in Windows, Linux, OS X.
| property | default value | allowed values | description |
| name |
|
string |
Exact process name that will be checked. |
| logic |
is_running |
is_running, is_not_running |
Check whether or not the process is running. |
Check whether or not a program can be found in the system path.
| property | default value | allowed values | description |
|
| condition |
|
is_in_path, is_not_in_path |
Condition to test for |
Compare a text with a regular expression.
| property | default value | allowed values | description |
|
| pattern |
|
string |
Regular expression |
| logic |
matches |
matches, does_not_match |
Whether or not the rule will apply if the regular expression matches. |
Perform tests over a registry entry. You can provide either a key or a key and a name
| property | default value | allowed values | description |
| name |
|
string |
Entry name to test for existence |
|
| wowMode |
none |
none, 32, 64 |
Determines whether we want to access a 32-bit or 64-bit view of the Registry |
| type |
REG_SZ |
REG_BINARY, REG_NONE, REG_SZ, REG_EXPAND_SZ, REG_DWORD, REG_BIG_ENDIAN, REG_LINK, REG_MULTI_SZ, REG_RESOURCE_LIST |
Type of the key to check with the is_type or is_not_type logic |
| logic |
exists |
exists, does_not_exist, is_empty, is_not_empty, is_type, is_not_type |
Comparison type |
Check if resource limit matches requirements.
| property | default value | allowed values | description |
|
| limitType |
hard |
hard, soft |
Limit type |
| type |
open_files |
core_file_size, data_seg_size, file_size, max_locked_memory, max_memory_size, open_files, pipe_size, stack_size, cpu_time, max_user_processes, virtual_memory |
Resource Type To Check |
| logic |
less |
equals, does_not_equal, greater_or_equal, greater, less, less_or_equal, is_unlimited, is_not_unlimited |
Comparison type |
Group a set of rules.
| property | default value | allowed values | description |
| ruleList |
|
string |
List of rules to be grouped |
| ruleEvaluationLogic |
and |
and, or |
Rule evaluation logic |
Check if there is another instance of the installer being executed.
| property | default value | allowed values | description |
| logic |
is_running |
is_running, is_not_running |
Condition to check. |
Check the string type
| property | default value | allowed values | description |
|
| type |
|
ascii, digit, alphanumeric, empty, not_ascii, not_digit, not_alphanumeric, not_empty |
Type of string |
Check if a particular user exists in the system or has a valid password.
| property | default value | allowed values | description |
| username |
|
string |
User name that will be checked. In the case of using Windows domains, it needs to be specified in the form username@DOMAIN |
| logic |
exists |
exists, not_exists, valid_password, invalid_password, is_windows_admin_account, is_windows_user_account, is_windows_guest_account |
Specifies the requirement to test over the given username. |
| password |
|
string |
If test logic is set to verify the password, the password to be checked. Currently only available on the Windows platform |
Check whether or not a specified account has proper rights
| property | default value | allowed values | description |
| rights |
|
string |
Account rights to test for, separated by spaces; Example value: SeServiceLogonRight. A complete list can be obtained from http://msdn.microsoft.com/en-us/library/aa375728(v=VS.85).aspx |
| account |
|
string |
User or group name to check; if account does not exist, rule always returns false |
Check whether a service exists and whether is running
| property | default value | allowed values | description |
| service |
|
string |
Name of service |
| condition |
|
exists, not_exists, is_running, is_not_running |
Condition to test for |
| property | default value | allowed values | description |
| name |
|
string |
Name of the parameter. This will be used to create the corresponding installer environment variable and command line option and because of that, it may only contain alphanumerical characters. |
| title |
|
string |
Title that will be displayed for the corresponding installer page. If none is specified, the description field will be used instead. |
| description |
|
|
Short description for the parameter |
| explanation |
|
|
Long description for the parameter |
| value |
|
string |
Value for the parameter. |
| default |
|
string |
Default value, in case one is not specified by the user. |
| ask |
|
0, 1 |
Whether or not to show or not the page to the end user (it can still be set through the command line interface). |
| cliOptionName |
|
string |
Text to use for setting the value of the parameter through the command line interface. If none is used, it will default to the value of the name field. |
| cliOptionShow |
|
0, 1 |
Whether or not the command line option will be shown in the command line when the help text is displayed |
| cliOptionText |
|
string |
Text to use when displaying help options. If none is used, it will default to the value of the description field. |
| insertAfter |
|
string |
Name of the page after the one in which this custom page will be installed |
| insertBefore |
|
string |
Name of the page previous to the one in which this custom page will be installed |
| leftImage |
|
string |
Image to show when displaying GUI installers with custom style |
| ruleEvaluationLogic |
|
and, or |
Rule evaluation logic, by default rules are evaluated with and logic |
| postShowPageActionList |
List of actions to run once page has been run and validated |
| preShowPageActionList |
List of actions to run right before a page is displayed |
| ruleList |
Conditions that are evaluated and depending on the result, the action is executed, the page associated with the parameter shown or the folder installed |
| validationActionList |
List of actions to run to validate the provided value. If an error is raised, then the user will be informed, and page will be dislay again |
Request a boolean value from the user.
| property | default value | allowed values | description |
| displayStyle |
radiobuttons |
radiobuttons, checkbox-left, checkbox-right |
Display style in GUI mode |
Allows you to create custom pages
| property | default value | allowed values | description |
| orientation |
vertical |
vertical, horizontal |
Set orientation for objects in the group. It can only be horizontal or vertical. If not specified, defaults to vertical. |
| parameterList |
|
string |
List of parameters to group |
| validationType |
always |
always, ifSelected |
Validation type |
Ask the user to select a value among a predefined list.
| property | default value | allowed values | description |
| width |
30 |
string |
Width in characters of the corresponding field in the GUI page. If not specified, it defaults to 40. |
| displayType |
combobox |
combobox, radiobuttons |
Choose an entry in a listbox or among a number of radiobuttons. |
| optionList |
|
string |
Predefined list of options that allows the user to select a value |
| ordering |
default |
default, alphabetical, alphabeticalreverse |
Order in which the text of choices will be displayed at runtime |
| allowEmptyValue |
1 |
0, 1 |
Whether or not to allow an empty value |
Allows you to create custom pages
| property | default value | allowed values | description |
| unselectedOptionsBehavior |
disable |
disable, none |
How unselected options will behave |
| orientation |
vertical |
vertical, horizontal |
Set orientation for objects in the group. It can only be horizontal or vertical. If not specified, defaults to vertical. |
| parameterList |
|
string |
List of parameters to group |
Ask the user to enter a directory
| property | default value | allowed values | description |
| width |
30 |
string |
Width in characters of the corresponding field in the GUI page. If not specified, it defaults to 40. |
| osxBundlesAreFiles |
0 |
0, 1 |
Whether or not OS X bundles (*.app and *.bundle) will be considered files. The setting will just have effect on OS X, in other platforms they will be always considered directories |
| mustExist |
0 |
0, 1 |
Whether or not to require that the directory must already exist. |
| mustBeWritable |
0 |
0, 1 |
Whether or not to require that the directory must be writable. |
| allowEmptyValue |
0 |
0, 1 |
Whether or not to allow an empty value |
Ask the user to enter a file
| property | default value | allowed values | description |
| width |
30 |
string |
Width in characters of the corresponding field in the GUI page. If not specified, it defaults to 40. |
| osxBundlesAreFiles |
0 |
0, 1 |
Whether or not OS X bundles (*.app and *.bundle) will be considered files. The setting will just have effect on OS X, in other platforms they will be always considered directories |
| mustExist |
0 |
0, 1 |
Whether or not to require that the file must already exist. |
| mustBeWritable |
0 |
0, 1 |
Whether or not to require that the file must be writable. |
| allowEmptyValue |
0 |
0, 1 |
Whether or not to allow an empty value |
Display a read-only text information page.
| property | default value | allowed values | description |
| htmlValue |
|
|
HTML text that will be shown in Qt mode. Note that regular text still needs to be provided in case the installer is run in another mode |
| trimMarginNumChars |
0 |
string |
Removes the specified number of characters from the left margin |
The label parameter displays a string of read-only text.
| property | default value | allowed values | description |
| image |
|
string |
Optional image to display |
Display a license
| property | default value | allowed values | description |
| file |
|
string |
File that will be displayed as license |
| description |
Installer.License.Label |
|
Short description for the parameter |
| htmlFile |
|
string |
HTML file that will be displayed as license |
| title |
Installer.License.Title |
string |
Title that will be displayed for the corresponding installer page. If none is specified, the description field will be used instead. |
| licenseFileList |
|
string |
List of licenses |
| wrapText |
0 |
0, 1 |
Wrap text |
| fileEncoding |
iso8859-1 |
iso8859-1, iso8859-2, utf-8, cp1251, cp1252, ascii, macRoman, unicode |
File encoding type |
The linkParameter displays an hyperlink-like label or a button, which executes an actionList when clicked.
| property | default value | allowed values | description |
| clickedActionList |
|
string |
List of actions to execute on click |
Allows you to create custom pages
| property | default value | allowed values | description |
| orientation |
vertical |
vertical, horizontal |
Set orientation for objects in the group. It can only be horizontal or vertical. If not specified, defaults to vertical. |
| parameterList |
|
string |
List of parameters to group |
Allow the user to input a password.
| property | default value | allowed values | description |
| width |
20 |
string |
Width in characters of the corresponding field in the GUI page. If not specified, it defaults to 40. |
| descriptionRetype |
|
string |
Description of retype field |
| askForConfirmation |
1 |
0, 1 |
If set to zero, the retype password field won't be shown. |
| allowEmptyValue |
1 |
0, 1 |
Whether or not to allow an empty value |
The string parameter allows you to request a text string from the user. It accepts all of the common options.
| property | default value | allowed values | description |
| width |
30 |
string |
Width in characters of the corresponding field in the GUI page. If not specified, it defaults to 40. |
| allowEmptyValue |
1 |
0, 1 |
Whether or not to allow an empty value |