Page History

...

Overview

...

Installer properties are the key to customising the Yellowfin installer. Different properties are used to make different changes to the installer, including:

...

Providing Values for Installer Properties

...

...

Values for installer properties can be set in different ways. In order of precedence, these are:

...

The silent installer does not display a user interface. Therefore all user options must be provided through the properties files or command-line arguments.

Custom Properties File

...

top

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

...

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.

Command-line Arguments

...

...

Installer properties may be provided as command-line arguments when running the installer. The general usage is:

...

Silent Installer Properties File

...

top

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.

...

Property keys in the silent installer properties file are not case sensitive.

Property Key	Value	Corresponding Key in custom.properties File
JavaHome	The java installation path to use when running Yellowfin.	option.javahome
InstallPath	The path to install Yellowfin into	option.installpath
InstallTutorialDatabase	Whether to install the tutorial database and sample content	option.pack.tutorial
LicenceFilePath	The location of the Yellowfin licence file	option.licencefile
ServicePort	The web server port	option.serverport
InstallService	Whether to install a Windows service	option.winservice
AppMemory	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).	option.appmemory
DatabaseType	The database type for the Yellowfin configuration database	option.db.dbtype
Authentication	The authentication type to use if the database type is SQL Server	option.db.sqlauthtype
LogonDomain	The logon domain to use if the database type is SQL Server, and the authentication type is Windows	option.db.sqldomain
SQLServerNamedInstance	The instance name to use if the database type is SQL Server. To use the default instance, omit this property.	option.db.sqlinstance
ProgressDriver	The location of the JDBC driver if the database type is Progress	option.db.progressdriver
CreateYellowfinDB	Whether to create a new database for the Yellowfin configuration database	option.db.createdb
CreateYellowfinDBUser	Whether to create a new database user	option.db.createuser
DatabaseHostname	The server hostname for the Yellowfin configuration database	option.db.hostname
DatabasePort	The server port for the Yellowfin configuration database	option.db.port
DatabaseName	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.	option.db.dbname
DatabaseDBAUser	The database admin username	option.db.dbausername
DatabaseDBAPassword	The database admin user password	option.db.dbapassword
DatabaseUser	The database username for the Yellowfin configuration database	option.db.username
DatabasePassword	The database user password for the Yellowfin configuration database	option.db.userpassword

...

ORACLEMODE	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.	option.db.oracleconnectionmode
JDBCDriverFiles	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.	option.db.jdbcdriverfiles
OracleAuth	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
KerberosFilePath	The absolute file path to where the Kerberos settings are kept.	Not available

Examples

Consider the following example:

InstallPath=/applications/yellowfin
InstallTutorialDatabase=true
ServicePort=8080
InstallService=false
DatabaseType=MySQL
CreateYellowfinDB=true
CreateYellowfinDBUser=talsefalse
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

...

top

...