InstallBuilder User Guide 24

Allow defining a new InstallBuilder action based on a number of existing actions

abortOnError

1

0, 1

Whether or not to set the new action to abort on error by default

name

string

Name of the new action

showMessageOnError

1

0, 1

Whether or not to set the new action to show an error message when an error occurs.

actionList

<action>

List of actions for the custom action

parameterList

<parameter>

List of parameters for the custom action

Creates a Java Launcher

allowCommandLineArguments

1

0, 1

Whether to pass arguments that launcher is given through command line.

arguments

string

Arguments to pass to application

binaryName

string

Name of the launcher executable

classpath

string

Classpath to provide to JVM, separated by semi colons

jarFile

string

JAR archive to use; overrides <classpath> and <mainClass>

mainClass

string

Class to run

osxApplicationBundleIcon

string

ICNS file to include in the Application Bundle

osxApplicationBundleIdentifier

com.installbuilder.javalauncher

string

Identifier used to uniquely identify this autoupdate package

osxApplicationBundleName

string

Name of the bundle to set, if specified

osxApplicationBundleVersion

1.0

string

Version to set, if specified

preferredJavaBinary

string

Path to preferred JRE; if Java runtime is found there, it will be used

requestedExecutionLevel

asInvoker

requireAdministrator, asInvoker, highestAvailable

UAC execution level of the application on Windows

runInBackground

1

0, 1

Whether to run this application in the background and exit launcher immediately

runInConsole

1

0, 1

Whether to run this application as console application in Windows.

selectionOrder

first

first, oldest, newest

Order of the Java versions detected

useLauncherDirectoryAsWorkingDirectory

1

0, 1

Whether to change working directory to launcher’s directory before proceeding with launching application

usePropertiesFile

0

0, 1

Whether to read properties file (named same as binary with .properties or launcher.properties on Mac OS X) to allow overriding certain parameters

vmParameters

string

Additional parameters to pass to JVM

windowsExecutableIcon

string

ICO file with a specific format to set the icon for the autoupdate executable file on Windows systems. The icon file can contain up to three different icons that must match one of the following formats: 16x16 pixels and 256 colors, 32x32 pixels and 256 colors, 48x48 pixels and 256 colors.

windowsResourceComments

string

Comments for resources embedded in Windows executable

windowsResourceCompanyName

string

Company Name for resources embedded in Windows executable

windowsResourceFileDescription

string

File Description for resources embedded in Windows executable

windowsResourceFileVersion

string

File version for resources embedded in Windows executable

windowsResourceInternalName

string

Internal Name for resources embedded in Windows executable

windowsResourceLegalCopyright

string

Legal Copyright for resources embedded in Windows executable

windowsResourceLegalTrademarks

string

Legal Trademarks for resources embedded in Windows executable

windowsResourceOriginalFilename

string

Original Filename for resources embedded in Windows executable

windowsResourceProductName

string

Product Name for resources embedded in Windows executable

windowsResourceProductVersion

string

Product Version for resources embedded in Windows executable

workingDirectory

string

Working directory to go to before launching

validVersionList

<validVersion>

List of supported Java versions

Defines a command executed when an action is invoked on the file

makeDefault

string

Enable this verb as the primary / default action.

runProgram

string

Program that will be executed when the action is invoked.

runProgramArguments

string

Program Arguments.

verb

string

Action that can be invoked on the file.

Java VM versions to allow

bitness

32, 64,

Whether only 32 or 64 bit version can be used

maxVersion

string

Max. Java version to allow

minVersion

string

Min. Java version to allow

requireJDK

0

0, 1

Whether the Java version is a JDK

vendor

sun, ibm, openjdk, kaffe,

Java VM vendor to allow

.NET Framework versions to allow

frameworkType

any

any, client, full

.NET Framework type; currently only valid for .NET FRamework version 4.0

maxVersion

string

Max. .NET Framework version to allow

minVersion

string

Min. .NET Framework version to allow

name

string

Query string variable name.

value

string

Query string value.

name

string

Name of the header

value

string

Value of the header

Replace the specified pattern with a value

pattern

string

Pattern or expression that will be replaced.

ruleEvaluationLogic

and

and, or

Rule evaluation logic, by default rules are evaluated with and logic

value

string

Value to replace the pattern with.

ruleList

<rule>

Contains a set of rules or conditions

description

string

image

string

Image that will be shown.

text

string

value

string

This property does not allow variables.

code

en

sq, ar, es_AR, de_AT, az, eu, pt_BR, en_GB, bg, fr_CA, ca, hr, cs, da, nl, en, et, fi, fr, de, el, he, hu, id, it, ja, kk, ko, lv, lt, es_MX, no, fa, pl, pt, ro, ru, sr, zh_CN, sk, sl, es, sv, de_CH, th, zh_TW, tr, tk, uk, va, vi, cy

Language identifier code, i.e. "en" (for english)

encoding

iso8859-1

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

Text file encoding, i.e. "utf-8"

file

string

Path that points to a license text file.

htmlFile

string

Path that points to a license HTML file (just allowed in qt mode)

resolveUCN

0

0, 1

Whether to resolve or not UCN escaped characters

file

string

Component file

platform

linux, linux-x64, linux-arm64, linux-arm32, linux-ia64, windows, windows-x64, osx, solaris-sparc, solaris-intel, linux-ppc, linux-s390, linux-s390x, freebsd, freebsd4, freebsd6, freebsd6-x64, freebsd7, freebsd7-x64, openbsd3, hpux, aix, irix-n32, rpm, deb

code

en

sq, ar, es_AR, de_AT, az, eu, pt_BR, en_GB, bg, fr_CA, ca, hr, cs, da, nl, en, et, fi, fr, de, el, he, hu, id, it, ja, kk, ko, lv, lt, es_MX, no, fa, pl, pt, ro, ru, sr, zh_CN, sk, sl, es, sv, de_CH, th, zh_TW, tr, tk, uk, va, vi, cy

Language identifier code, i.e. "en" (for english)

encoding

iso8859-1

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

Text file encoding, i.e. "utf-8"

file

string

resolveUCN

0

0, 1

Whether to resolve or not UCN escaped characters

code

en

sq, ar, es_AR, de_AT, az, eu, pt_BR, en_GB, bg, fr_CA, ca, hr, cs, da, nl, en, et, fi, fr, de, el, he, hu, id, it, ja, kk, ko, lv, lt, es_MX, no, fa, pl, pt, ro, ru, sr, zh_CN, sk, sl, es, sv, de_CH, th, zh_TW, tr, tk, uk, va, vi, cy

Language identifier code, i.e. "en" (for english)

encoding

iso8859-1

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

Text file encoding, i.e. "utf-8"

file

string

Path that points to a readme text file.

resolveUCN

0

0, 1

Whether to resolve or not UCN escaped characters

path

string

500x222 GIF or PNG logo image to be displayed during installation

ruleEvaluationLogic

and

and, or

Rule evaluation logic

ruleList

<rule>

Contains a set of rules or conditions