InstallBuilder User Guide 23

abortOnError

1

0, 1

Whether or not to abort the installation on an error while executing the action.

breakpoint

0

0, 1

Breakpoint

customErrorMessage

string

Show a custom error message.

explanation

text

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

and, or

Boolean operator for rule concatenation

run

1

0, 1

Whether or not to run the related action or not

show

1

0, 1

Show or hide the checkbutton in the final page action list

showMessageOnError

1

0, 1

Whether or not to show an error message when an error occurs.

onErrorActionList

<action>

List of actions to execute if the action fails

ruleList

<rule>

List of rules to satisfy in order to evaluate the current element

Write text to console

text

text

Text to write

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Prompt a choice question dialog to the user.

defaultValue

string

Default value

text

text

Information message that will be shown

title

Choose an option

string

Dialog title

variable

string

Variable to store choice

optionList

<option>

Predefined list of options that allows the user to select a value

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Prompt an info dialog to the user.

text

text

Information message that will be shown

title

$\{msg(MessageDialog.Info)\}

string

Title of the dialog window

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Ask the user to enter a password.

text

text

Question message that will be shown.

title

string

Dialog window title.

variable

string

Variable name where the password will be stored.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Display an indeterminate progressmeter in a popup window to execute a list of actions.

height

100

positive integer or zero

Popup window height

title

Please wait

string

Title of the progress dialog window

width

300

positive integer or zero

Popup window width

actionList

<action>

Actions to Execute

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Prompt a question to the user. The result is stored as yes or no in the given variable name.

default

yes

yes, no

Default answer, it can be yes or no.

text

text

Question message that will be shown.

title

$\{msg(MessageDialog.Question)\}

string

Title of the dialog window

variable

string

Variable name where the result will be stored

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Ask the user a question.

text

string

Question message that will be shown.

title

string

Dialog window title.

variable

string

Variable name where the answer will be stored.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Display a read-only text dialog to the user.

fixedFont

0

0, 1

Show text with monospaced font

height

600

positive integer or zero

Text window height

htmlText

text

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

text

text

Text that will be shown.

title

string

Dialog title.

width

500

positive integer or zero

Text window width

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Shows a warning dialog with the given text.

text

Warning message goes here

text

Warning message that will be shown.

title

$\{msg(MessageDialog.Warning)\}

string

Title of the dialog window

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

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.

text

Unknown Error

text

Error message

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Validate a group of actions

severity

error

error, warning, info

Severity of the dialog

text

text

message that will be shown.

type

abortRetryIgnore

abortRetryIgnore, abortRetry

Dialog type

actionList

<action>

List of actions to be grouped

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Add a directory to the system path. This will modify the registry on windows and the appropiate shell initialization files on Unix systems

insertAt

end

beginning, end

Where to insert the new directory in the PATH (currently Unix only)

path

string

Path to the directory

scope

system

system, user

Select user path or system path.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Add a system environment variable. This will modify the registry on Windows and the appropiate shell initialization files on Unix systems.

name

string

Environment variable name.

scope

system

system, user

Scope.

username

string

User to modify the environment for. If empty, the current user will be used

value

string

Variable name

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Add fonts to the Windows system

excludeFiles

string

Patterns to exclude files

files

string

File patterns to apply action to

matchHiddenFiles

0

0, 1

Whether or not to attempt to match Windows hidden files

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Add a path in which the system will search for shared libraries on Linux

path

string

Path to add to the system search for dynamic libraries on Linux

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Delete an environment variable from the system.

name

string

Environment variable name.

scope

system

system, user

Scope.

username

string

User to modify the environment for. If empty, the current user will be used

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Get the current working directory

variable

string

Variable to which to save the current working directory.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Remove a directory from the System Path. This will modify the System Path

path

string

Path to the directory

scope

system

system, user

Select user path or system path.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Remove fonts from the Windows system

excludeFiles

string

Patterns to exclude files

files

string

File patterns to apply action to

matchHiddenFiles

0

0, 1

Whether or not to attempt to match Windows hidden files

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

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.

name

string

Variable name

value

string

Variable value

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Add directories to the uninstaller.

addContents

0

0, 1

Whether or not to add directory contents to the uninstaller

excludeFiles

string

Patterns to exclude files

files

string

File patterns to apply action to

matchHiddenFiles

0

0, 1

Whether or not to attempt to match Windows hidden files

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Add files to uninstaller.

excludeFiles

string

Patterns to exclude files

files

string

File patterns to apply action to

matchHiddenFiles

0

0, 1

Whether or not to attempt to match Windows hidden files

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Append text to a file. If the file does not exist, it will be created.

encoding

iso8859-1

iso8859-1, iso8859-2, utf-8, cp1251, cp1252, ascii, macRoman, unicode, default, binary

Encoding of the text file

endOfLineConversion

auto

auto, none, cr, crlf, lf

End Of Line Conversion

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

text

text

Text to append

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Convert plain text files in DOS/Mac format to Unix format.

excludeFiles

string

Patterns to exclude files

files

string

File patterns to apply action to

matchHiddenFiles

0

0, 1

Whether or not to attempt to match Windows hidden files

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Extract property values out of a INI file.

file

string

Path to INI file

key

string

Property Key

section

string

INI section

variable

string

Variable name to save property to

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Set property values of a INI file.

file

string

Path to INI file

key

string

Property Key

section

string

INI section

value

string

Property Value

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Extract property values out of a properties file.

encoding

default

iso8859-1, iso8859-2, utf-8, cp1251, cp1252, ascii, macRoman, unicode, default, binary

Encoding of the text file

endOfLineConversion

auto

auto, none, cr, crlf, lf

End Of Line Conversion

file

string

Path to the property file

key

string

Property key

variable

string

Variable name to save property to

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Writes out property values to a properties file, creating a new file if it does not exist.

encoding

default

iso8859-1, iso8859-2, utf-8, cp1251, cp1252, ascii, macRoman, unicode, default, binary

Encoding of the text file

endOfLineConversion

auto

auto, none, cr, crlf, lf

End Of Line Conversion

file

string

Path to the property file

key

string

Property key

value

string

Value to set the key to.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Read the contents of a file and save it in a variable.

encoding

iso8859-1

iso8859-1, iso8859-2, utf-8, cp1251, cp1252, ascii, macRoman, unicode, default, binary

Encoding of the text file

endOfLineConversion

auto

auto, none, cr, crlf, lf

End Of Line Conversion

name

string

Variable to which to save the file contents

path

string

Path to the file you wish to read the contents from

removeBOM

0

0, 1

Whether or not to remove or not Byte Order Mark on Unicode files

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Remove files or directories from uninstaller.

excludeFiles

string

Patterns to exclude files

files

string

File patterns to apply action to

matchHiddenFiles

0

0, 1

Whether or not to attempt to match Windows hidden files

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Substitute a value in a file.

encoding

binary

iso8859-1, iso8859-2, utf-8, cp1251, cp1252, ascii, macRoman, unicode, binary

Encoding of the files to substitute

excludeFiles

string

Patterns to exclude files

files

string

File patterns to apply action to

matchHiddenFiles

0

0, 1

Whether or not to attempt to match Windows hidden files

type

regexp

regexp, exact

Type of substitution, regular expression or exact

substitutionList

<substitution>

List of patterns/values for a substitution

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Convert plain text files in Unix format to DOS format.

excludeFiles

string

Patterns to exclude files

files

string

File patterns to apply action to

matchHiddenFiles

0

0, 1

Whether or not to attempt to match Windows hidden files

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Create or replace a file with a certain text content.

encoding

default

iso8859-1, iso8859-2, utf-8, cp1251, cp1252, ascii, macRoman, unicode, default, binary

Encoding of the text file

endOfLineConversion

auto

auto, none, cr, crlf, lf

End Of Line Conversion

path

string

Path of the file to be created or replaced

text

text

Text to write

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Comment entire subtree of an XML file

element

string

XPath expression pointing to the selected element

file

string

Path to XML file

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Read value of element or attribute from an XML file

attribute

string

If present, the action will refer to the attribute instead of the element

element

string

XPath expression pointing to the selected element

file

string

Path to XML file

variable

string

Variable where to start the result

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Set the value of an element or attribute in an XML file

attribute

string

If present, the action will refer to the attribute instead of the element

element

string

XPath expression pointing to the selected element

file

string

Path to XML file

value

string

Value to store in element or attribute

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Read value of element from a YAML file

element

string

Path expression pointing to the selected element

file

string

Path to YAML file

variable

string

Variable where to start the result

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Set the value of an element in a YAML file

element

string

Path expression pointing to the selected element

file

string

Path to YAML file

value

string

Value to store in element

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Create a copy of a file or directory. The destination file or directory will be overwritten if it already exists

destination

string

Path to where the file will be copied.

excludeFiles

string

Patterns to exclude files

matchHiddenFiles

0

0, 1

Whether or not to attempt to match Windows hidden files

origin

string

Path to the original file.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

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.

destination

string

Path to the destination backup folder.

path

string

Path to original file you wish to backup.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Create a new directory

path

string

Path to the new directory

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Creates one or more shortcuts in specified location.

destination

string

Path to the location where you want to create the shortcuts.

shortcutList

<shortcut>

List of shortcuts to create.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Create a symbolic link to a file. It is the equivalent to the Unix ln command.

linkName

string

Symbolic link name.

target

string

Path to the file to which you want to create a symbolic link.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Delete a file or directory (including its contents). The action does not throw an error if deleting a file or directory failed.

excludeFiles

string

Patterns to exclude files

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

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Gets Information About File Or Directory

followSymLinks

0

0, 1

Whether or not to follow or not symbolic links

path

string

Path

type

and

size, type

Type of information to retrieve

variable

string

Variable to store result in

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

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.

link

string

Symbolic link path

variable

string

Variable to store result

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Change the name of a file or directory

destination

string

New name of the file.

excludeFiles

string

Patterns to exclude files

matchHiddenFiles

0

0, 1

Whether or not to attempt to match Windows hidden files

origin

string

Original name of the file.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

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.

createIfNotExists

1

0, 1

Whether or not to create the file in case it does not exist

matchHiddenFiles

0

0, 1

Whether or not to attempt to match Windows hidden files

path

string

Path to the file/directory to be touched

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Extract a directory from an installer before files are unpacked during the installation phase

addToUninstaller

0

0, 1

If enabled, adds unpacked objects to uninstaller so they are removed during uninstallation

component

string

Project component where the directory you want to extract is located.

destination

string

Path to the location where you want to extract the directory.

folder

string

Project folder name where the directory you want to extract is located.

origin

string

Directory name you want to extract.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Extract files from an installer before files are unpacked during the installation phase

addToUninstaller

0

0, 1

If enabled, adds unpacked objects to uninstaller so they are removed during uninstallation

component

string

Project component where the file you want to extract is located

destination

string

Path to the location where you want to extract the file

folder

string

Project folder name where where the file you want to extract is located

origin

string

File name you want to extract

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Extract content from a zip file to a destination folder.

addToUninstaller

0

0, 1

If enabled, adds unpacked objects to uninstaller so they are removed during uninstallation

destinationDirectory

string

Path to the folder where you want the file content to be extracted. The folder must exist and must be writable

zipFile

string

ZIP file that will be uncompressed

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Pack one or more files to a zip file, relative to base directory.

baseDirectory

string

Directory that all files will be packed relatively to

excludeFiles

string

Patterns to exclude files

files

string

File patterns to apply action to

matchHiddenFiles

0

0, 1

Whether or not to attempt to match Windows hidden files

zipFile

string

ZIP file that will be created

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Break current loop

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Continue current loop

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Iterate over a set of values

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

<action>

List of actions

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Conditionally execute a group of actions

conditionRuleEvaluationLogic

and

and, or

Condition rule evaluation logic

actionList

<action>

List of actions to execute if condition is true

conditionRuleList

<rule>

List of conditions

elseActionList

<action>

List of actions to execute if condition is false

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Execute a group of actions as long as conditions are met

conditionRuleEvaluationLogic

and

and, or

Condition rule evaluation logic

actionList

<action>

List of actions

conditionRuleList

<rule>

List of conditions

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Access a URL and save the result into a file.

filename

string

Filename to which to save the result to

password

string

Password for URLs that require authentication

url

string

URL to launch

username

string

Username for URLs that require authentication

httpHeadersList

<httpHeader>

List of headers for the request

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Access a URL using HTTP POST and save the result into a file.

contentType

string

Content-type HTTP header.

data

text

Raw data that will be included in the POST query.

filename

string

Filename to which to save the result to

password

string

Password for URLs that require authentication

url

string

URL to launch

username

string

Username for URLs that require authentication

httpHeadersList

<httpHeader>

List of headers for the request

queryParameterList

<queryParameter>

List of variables that will be included in the POST query.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Configure proxy to be used by http actions

exclude

127.0.0.1

string

Space separated list of patters for urls that will be excluded from the proxy configuration

password

string

Proxy server password

port

string

Proxy server port

server

string

Proxy server url

username

string

Proxy server username

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Launch the default web browser with a given URL.

url

string

URL of the page to be shown.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Decode a given text using URL formatting specifications and place the result in a variable.

text

text

Text to decode

variable

string

Variable to store the result in

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Encode a given text using URL formatting specifications and place the result in a variable.

text

text

Text to encode

variable

string

Variable to store the result in

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Group a set of actions.

actionList

<action>

List of actions to be grouped

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Add options to an existing choice parameter

name

string

Name of an existing choice parameter.

optionList

<option>

List of options to give to a choice parameter

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Add options to an existing choice parameter from a given text

name

string

Name of an existing choice parameter.

text

text

Text with the options to give to a choice parameter

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Select or deselect components for installation.

deselect

string

Comma separated list of components you wish to deselect for installation.

select

string

Comma separated list of components you wish to select for installation.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Decode a string using base64.

text

string

Text to process

variable

string

Variable to save the final result to.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Encode a string using base64.

text

string

Text to process

variable

string

Variable to save the final result to.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Exit the installer/uninstaller.

exitCode

0

positive integer or zero

exit code returned by the installer/uninstaller

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Generate a random value.

length

32

positive integer or zero

Character length for the generated value.

variable

string

Variable to which to save the generated value.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

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.

names

string

Variable names

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Write a message to the installation log. Useful for debugging purposes.

enableTimeStamp

1

0, 1

Whether to enable timestamp in the message or not.

text

text

Message to include in log

timeStampFormat

[%H:%M:%S]

string

Format string for the optional timestamp. The string allows a number of field descriptors.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Calculate math expression

text

string

variable

string

Variable to save the final result to.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Generate a MD4 from a given text.

text

text

Text to calculate the MD4 on.

useNTLMFormat

1

0, 1

Whether or not to create an NTLM compilant hash

variable

string

Variable to which to save the MD4 to.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Generate a MD5 from a given text.

text

text

Text to calculate the MD5 on.

variable

string

Variable to which to save the MD5 to.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Clear choice values for a parameter

name

string

Name of an existing choice parameter.

options

string

Options to remove

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Specifies and verifies password to use for copying files from installer

password

string

Password to use; action will throw error if password specified does not match password from build time

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Set a installer variable. If the name of the variable matches a parameter name, the value of the parameter will be updated.

name

string

Variable name

persist

0

0, 1

Whether the variable will be available in the uninstaller as well.

value

text

Value to set the variable to

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

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.

name

string

Name of the variable to set

pattern

string

Pattern to match

substitution

string

Value to replace matched text with

text

text

Text to match

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

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.

exec

string

Path to the script to run

execArgs

string

Arguments to pass to the script

name

string

Name of the variable to set

workingDirectory

string

Working directory. This is important for scripts that expect to be run from a specific location

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Generate a SHA-1 from a given text.

text

text

Text to calculate the SHA-1 on.

variable

string

Variable to which to save the SHA-1 to.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Generate a SHA-256 from a given text.

text

text

Text to calculate the SHA-256 on.

variable

string

Variable to which to save the SHA-256 to.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Perform one of the allowed transformations in the specified text, storing the result into a variable.

logic

trim

toupper, tolower, totitle, trimleft, trimright, trim

Transformation to perform.

text

text

Text which will be transformed.

variable

string

Variable name which will store the result.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Pause the installation for given time

ms

string

Number of milliseconds to wait

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

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

promptUser

0

0, 1

Prompt user to choose appropriate version

selectionOrder

first

first, oldest, newest

Order of the Java versions detected

validVersionList

<validVersion>

List of supported Java versions

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Creates one or more Java launchers in specified location.

destination

string

Path to the location where you want to create the launchers.

javaLauncherList

<javaLauncher>

List of launchers to create.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

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

creator

string

Creator to set to file or directory

excludeFiles

string

Patterns to exclude files

files

string

File patterns to apply action to

hidden

unchanged

1, 0, unchanged

Whether the file is visible or not

readOnly

unchanged

1, 0, unchanged

Whether the file is read only or writable

type

string

Type to set to file or directory

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

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.

key

string

Registry key

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

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

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.

dataPattern

*

string

Pattern to match in the value

findAll

0

0, 1

Whether to look for the first occurrence or for all

keyPattern

*

string

Pattern to match key name with

namePattern

*

string

Pattern to match entry name with

rootKey

HKEY_LOCAL_MACHINE\SOFTWARE

string

Root key from which start the search

searchDepth

0

positive integer or zero

Maximum depth of the search. 0 will look just in the Root Key

variable

string

Variable name to store the results

wowMode

none

none, 32, 64

Determines whether we want to access a 32-bit or 64-bit view of the Registry

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

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.

key

string

Registry key

name

string

Entry name to read value from

variable

string

Variable name to store registry value to

wowMode

none

none, 32, 64

Determines whether we want to access a 32-bit or 64-bit view of the Registry

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

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.

key

string

Registry key

variable

string

Variable to store result

wowMode

none

none, 32, 64

Determines whether we want to access a 32-bit or 64-bit view of the Registry

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

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 *)

key

string

Registry key

name

string

Entry name to read value from

variable

string

Variable name to store registry value to

wowMode

none

none, 32, 64

Determines whether we want to access a 32-bit or 64-bit view of the Registry

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Create a new registry key or modify the value of an existing registry key.

key

string

Registry key

name

string

Entry name to set or modify value to

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

value

string

Value to set to the registry key

wowMode

none

none, 32, 64

Determines whether we want to access a 32-bit or 64-bit view of the Registry

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

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.

description

string

Product description

name

string

Service Name

program

string

Path to the program

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Create Mac OS X service.

abandonProcessGroup

0

0, 1

Don’t kill the remaining processes with the same group ID.

groupname

string

Groupname

keepAlive

1

0, 1

Keep process alive by launchctl

program

string

Path to program

programArguments

string

Arguments to pass to the program

scope

user

user, system

Scope of service

serviceName

string

Identifier for the service name

username

string

Username

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Register a program as a Windows service.

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.

dependencies

string

Comma separated list of services that the created service depends on

description

string

Program description

displayName

string

Name displayed in the Windows service control panel

password

string

Password for the user account if one is specified.

program

string

Path to program

programArguments

string

Arguments to pass to the program

serviceName

string

Internal service name

startType

auto

auto, manual, disabled

Specify how the service should be started

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Delete Mac OS X service.

scope

user

user, system

Scope of service

serviceName

string

Identifier for the service name

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Delete a Windows service

displayName

string

Name displayed in the Windows service control panel

serviceName

string

Internal service name

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Return a unique service name

displayName

string

Initial display name for the service

selectedDisplayNameVariable

string

Variable to store the service display name

selectedServiceNameVariable

string

Variable to store the Service name

serviceName

string

Initial name for the service

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

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.

name

string

Service Name

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Restart a Windows service

delay

15000

positive integer or zero

Amount of milliseconds to wait for the service to start / stop.

displayName

string

Name displayed in the Windows service control panel

serviceName

string

Internal service name

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Start Mac OS X service.

serviceName

string

Identifier for the service name

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Start a Windows service

delay

15000

positive integer or zero

Amount of milliseconds to wait for the service to start.

displayName

string

Name displayed in the Windows service control panel

serviceName

string

Internal service name

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Stop Mac OS X service.

serviceName

string

Identifier for the service name

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Stop a Windows service

delay

15000

positive integer or zero

Amount of milliseconds to wait for the service to stop.

displayName

string

Name displayed in the Windows service control panel

serviceName

string

Internal service name

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Adds a program to be executed whenever a window manager session starts (only Linux KDE/Gnome supported).

description

string

The description of the program.

name

string

The name of this startup item.

program

string

Path to the program to be executed when the session starts.

programArguments

string

Arguments to be considered when running the program (only available for GNOME).

username

${system_username}

string

User to add the Startup item for. If empty, the current user will be used

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

This action allows you to create a timestamp using a custom format, storing the result in an installer variable.

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.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

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.

path

string

The path from which the base directory will be retrieved.

variable

string

Variable that will store the directory path.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Search for a file in a directory and all the subdirectories.

baseDirectory

string

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

pattern

string

Pattern for the file that will be searched. The pattern can contain wildcards (*,?).

variable

string

Variable where the full path to the first matching file will be stored

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Calculate the disk usage (KiloBytes) for a file or set of files, and save the value in the given variable.

excludeFiles

string

Patterns to exclude files

files

string

File patterns to apply action to

matchHiddenFiles

0

0, 1

Whether or not to attempt to match Windows hidden files

units

KB

KB, MB, GB

Size units for the returned value.

variable

string

Variable to which to save the result of the calculation

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Calculate the free disk (KiloBytes) space and save the value in the given variable. Returns -1 if free space cannot be determined.

path

string

Path to the folder or disk

units

KB

KB, MB, GB

Size units for the returned value.

variable

string

Variable to which to save the result of the calculation

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Returns the number of the first available port in a range of port numbers specified by initialPort and finalPort (both inclusive).

finalPort

string

The final port number on the range (inclusive).

initialPort

string

The initial port number on the range (inclusive).

variable

string

Variable that will store the free port number.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Gets Name Of Process Using Specified Port

pidVariable

string

Variable to use for storing id of the process using the port

port

string

TCP port to check

variable

string

Variable to use for storing name of the process using the port

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Get the total disk (KiloBytes) space and save the value in the given variable. Returns -1 if total space cannot be determined.

path

string

Path to the folder or disk

units

KB

KB, MB, GB

Size units for the returned value.

variable

string

Variable to which to save the result of the calculation

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

This action allows you to kill a running process that matches one or several conditions. Windows support only.

name

string

Name of the process, usually the executable filename.

path

string

Path to the executable of the process.

pid

string

ID of the process to be killed.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Based on command given, locates binary and creates command that needs to be run.

command

string

Command to locate

variable

string

Variable to store the result in

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Performs change on the path and returns it in variable

action

absolutize

absolutize, nativeAbsolutize, nativize

Action to perform on the path

path

string

The path to manipulate

variable

string

Variable that will store the new path.

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Run a program or script

program

string

Path to program or script to run

programArguments

string

Program arguments

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

runAsShell

text

When configuring the runAs property, shell used to run the program. (not supported on OS X)

stdin

text

Text to send to program’s standard input.

useMSDOSPath

1

0, 1

Whether or not to use or not MSDOS program name path on Windows

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

Common properties:

abortOnError, breakpoint, customErrorMessage, explanation, progressText, ruleEvaluationLogic, run, show, showMessageOnError, onErrorActionList, ruleList

Pause the installation for a maximum timeout until a server process is listening in the specified port

port

string

TCP port to check

state

in_use

free, in_use

Wait for port to be free or in use.

timeout

string

Maximum amount of time to wait (in milliseconds)