Installer properties are the key to customising the Yellowfin installer. Different properties are used to make different changes to the installer, including:
Values for installer properties can be provided in different ways.
The Installer Properties are grouped into the following pages:
Values for installer properties can be set in different ways. In order of precedence, these are:
For example, a property value specified on the command line will override a value set for the same property in the custom properties file.
The silent installer does not display a user interface. Therefore all user options must be provided through the properties files or command-line arguments.
The custom properties file is the main way to customise the installer. You can add properties to this file that modify the way the installer looks and behaves. This file is a java properties file named
custom.properties that is added to the root of the installer archive (see Adding Files to the Installer).
This file is used to provide standard default values for installation options, override text displayed during installation, specify the location of images used to override the default images used by the installer, modify the installer behaviour and provide initial configuration values for the Yellowfin installation. Options in the custom properties file will be overridden if a value for the same property is provided as a command-line argument to the installer, and user options can be overridden during the installation process when using the graphical or command-line installer.
The custom properties file is a series of key-value pairs of the form “key=value” on separate lines. Blank lines are ignored, and a line starting with a # is treated as a comment.
Installer properties may be provided as command-line arguments when running the installer. The general usage is:
java -jar yellowfin-yyyymmdd-full.jar [-cmd|-gui] [property ...] java -jar yellowfin-yyyymmdd-full.jar -silent [silentpropertiesfile [property ...]]
Properties are specified using:
java -jar yellowfin-yyyymmdd-full.jar option.serverport=80 option.winservice=true
An additional properties file may be specified when using the silent installer. For historical reasons, the properties in this file have different names to the standard installer properties, but have the same functionality.
It is recommended to use the custom properties file instead of the silent installer properties file where possible. The properties available to be set through the silent installer properties file are very limited in comparison to the custom properties file.
The silent installer properties file must exist on the file system of the computer being installed onto. The file name must be the first argument after the -silent switch:
java -jar yellowfin-yyyymmdd-full.jar -silent install.properties
When passing command-line arguments to the silent installer, you must include a silent installer properties file as the first argument before any additional options, even if it is just an empty file. The following will not work:
java -jar yellowfin-yyyymmdd-full.jar -silent option.serverport=8090
Property keys in the silent installer properties file are not case sensitive.
Corresponding Key in
The java installation path to use when running Yellowfin.
The path to install Yellowfin into
Whether to install the tutorial database and sample content
The location of the Yellowfin licence file
The web server port
Whether to install a Windows service
The amount of memory in megabytes to assign to Yellowfin at install time (if not set, it defaults to 75% of the server’s RAM).
The database type for the Yellowfin configuration database
The authentication type to use if the database type is SQL Server
The logon domain to use if the database type is SQL Server, and the authentication type is Windows
The instance name to use if the database type is SQL Server. To use the default instance, omit this property.
The location of the JDBC driver if the database type is Progress
Whether to create a new database for the Yellowfin configuration database
Whether to create a new database user
The server hostname for the Yellowfin configuration database
The server port for the Yellowfin configuration database
The database name for the Yellowfin configuration database.
Note: If installing Oracle, use this key to specify the SID, or service name, based on the selected Oracle connection mode.
The database admin username
The database admin user password
The database username for the Yellowfin configuration database
The database user password for the Yellowfin configuration database
The connection method to connect to an Oracle database. Options include SID or service. The value of the selected method must be specified using the DatabaseName key.Note: This property key must be specified if using the silent installer to install an Oracle database. See Oracle example below.
Path to JDBC driver files. Specify multiple paths by separating them with commas.
Tip: Use this to supply the jar files of database drivers that are not readily packaged with the installer.
|The method Oracle should use to authenticate its user. The value can be kerberos (using Kerberos Authentication) or user (using username and password).||Not available|
|The absolute file path to where the Kerberos settings are kept.||Not available|
Consider the following example:
InstallPath=/applications/yellowfin InstallTutorialDatabase=true ServicePort=8080 InstallService=false DatabaseType=MySQL CreateYellowfinDB=true CreateYellowfinDBUser=false DatabaseHostname=localhost DatabaseName=yellowfin DatabaseDBAUser=root DatabaseDBAPassword=secret DatabaseUser=yf DatabasePassword=
Below is an example of required property keys for installing an Oracle database:
DatabaseType=Oracle DatabasePort=1521 ORACLEMODE=service DatabaseName=ORCL