Page Comparison

{anchor:top}
{toc: class=contents}
h2. OverviewOptions

{styleclass: Class=topLink}[top|#top]{styleclass}
Properties in this h2.section Customare Propertiesused Fileto {styleclass: Class=topLink}[top|#top]{styleclass}
The custom properties file ({{custom.properties}}) is included provide initial values for the user entry options in the installer. All options that affect the installation behaviour When using the graphical and command-line installers, these will be used as defaults that the user can override at installation time. Certain user options can be set in this file. See [Adding Files to the Installer] for more information.


h3.{expand:title=Properties}
The following properties are used to populate default user options, or provide the installation options used in silent installation.
||Property||Value||
|{{option.installpath}}|The directory to install into [*|#note]|
|{{option.winservice}}|{{true}}/{{false}}
Install a Windows Service to Start/Stop Yellowfin|
|{{option.licencefile}}|Location of the Yellowfin Licence File [*|#note]|
|{{option.serverport}}|App Server Port
Default = {{80}}|
|{{option.db.dbtype}}|The Database Type to install into. Valid values are:
{{CacheDB}}, {{DB2}}, {{HSQLDB}}, {{Ingres}}, {{MySQL}}, {{Oracle}}, {{PostgreSQL}}, {{Progress}}, {{SQLServer}}, {{SybaseASE}}, {{SybaseASA}}|
|{{option.db.createdb}}|{{true}}/{{false}}
Create a new Database for Yellowfin|
|{{option.db.createuser}}|{{true}}/{{false}}
Create a new Database User for Yellowfin|
|{{option.db.sqlauthtype}}|{{sqlserver}}/{{windows}}
The Authentication Type to use when connecting to SQL Server. 
Only used if {{option.db.dbtype=SQLServer}}
Default = {{sqlserver}}|
|{{option.db.sqldomain}}|The Authentication Domain to use when connecting to SQL Server.
Only used if {{option.db.sqlauthtype=sqlserver}}|
|{{option.db.sqlinstance}}|The Named Instance to use when connecting to SQL Server.
Only used if {{option.db.dbtype=SQLServer}}|
 hidden from the user, in which case they cannot override the values provided for these properties.

When using the silent installer, these options must be used to specify the installation parameters.

h3. Installation Path
||Property|{{option.installpath}}|
||Value|The path to install Yellowfin into. This value should be the full path name to install Yellowfin into. The directory will be created if it does not already exist.|
||Example|{{option.installpath=/usr/local/Yellowfin}}|

h3. Tutorial Pack Installation
||Property|{{option.pack.tutorial}}|
||Value|Set this to {{true}} or {{false}} to determine whether to install the Ski Team tutorial database and sample content.|
||Default|{{true}}|
||Example|{{option.pack.tutorial=true}}|

h3. World GeoPack Installation
||Property|{{option.pack.geopack.world}}|
||Value|Set this to {{true}} or {{false}} to determine whether to install the World Countries GeoPack.|
||Default|{{false}}|
||Example|{{option.pack.geopack.world=true}}|

h3. US GeoPack Installation
||Property|{{option.pack.geopack.us}}|
||Value|Set this to {{true}} or {{false}} to determine whether to install the US GeoPack.|
||Default|{{false}}|
||Example|{{option.pack.geopack.us=true}}|

h3. Licence File Location
||Property|{{option.licencefile}}|
||Value|The path to the Yellowfin licence file. This value should be the full path to the licence file which should exist on the installation target computer at install time.|
||Example|{{option.licencefile=/usr/local/yellowfin.lic}}|

h3. Server Port
||Property|{{option.serverport}}|
||Value|The server port that Yellowfin will use. This value should be a valid port number between 1 and 65535. At installation time, the installer checks if the port is available. If not, a warning is displayed to the user.|
||Default|Selects an available port starting with 8080|
||Example|{{option.serverport=8080}}|

h3. Windows Service
||Property|{{option.winservice}}|
||Value|Set to {{true}} to install a Windows Service. This property is ignored on other Operating Systems.|
||Default|{{false}}|
||Example|{{option.winservice=true}}|

h3. Database Type
||Property|{{option.db.dbtype}}|
||Value|The database type to use for the Yellowfin configuration database. The available values are:
{{AS400}} - _(AS/400 DB2)_
{{CacheDB}}
{{DB2}}
{{HSQLDB}} - _(Embedded database)_
{{Ingres}}
{{MySQL}}
{{Oracle}}
{{PostgreSQL}}
{{Progress}} - _(Progress 9)_
{{SQLServer}} - _(Microsoft SQL Server)_
{{SQLServerAzure}} - _(Microsoft SQL Server Azure)_
{{SybaseASA}} - _(Sybase SQL Anywhere / IQ)_
{{SybaseASE}} - _(Sybase ASE)_|
||Example|{{option.db.dbtype=PostgreSQL}}|

h3. Progress JDBC Driver
||Property|{{option.db.progressdriver}}|Location
||Value|The location of the Progress JDBC driver file [*|#note]
Only used if . This file should exist on the installation target computer (not the computer where the installer is built). This is ignored for other database types.|
||Example|{{option.db.dbtype=Progressprogressdriver=/usr/local/dlc/java/jdbc.jar}}|

h3. Database Hostname
||Property|{{option.db.hostname}}|Database Server Hostname
Default = {{|
||Value|The Yellowfin configuration database server hostname.|
||Example|{{option.db.hostname=localhost}}|

h3. Database Port
||Property|{{option.db.port}}|Database Connection Port
Default depends on Database Type|
||
||Value|The Yellowfin configuration database server port. If this value is omitted, the default port for the selected database type will be used.|
||Example|{{option.db.dbnameport=5432}}|

h3. Database Name
Default = {{Yellowfin}}|
||Property|{{option.db.usernamedbname}}|
||Value|DatabaseThe UsernameYellowfin Defaultconfiguration = {{YellowfinUser}}database name.|
||Example|{{option.db.userpassworddbname=yellowfin}}|Database

Userh3. PasswordCreate DefaultNew = {{password}}|
Database
||Property|{{option.db.dbausernamecreatedb}}|Database
DBA Username
Used when creating||Value|Set to {{true}} to create a new database to use as the Yellowfin configuration database or user|
|. This property is ignored if the selected database type does not support creating databases.|
||Example|{{option.db.dbapasswordcreatedb=true}}|Database DBA User Password|


h3. SQL Server Instance Name
||Property|{{option.packdb.tutorialsqlinstance}}|{{true}}/{{false}}
Install the Tutorial Database and Sample Reports
Default = {{true}}|
|
||Value|The instance name to use when connecting to SQL Server. This property is ignored for other database types. If this value is omitted, the default instance will be used.|
||Example|{{option.db.sqlinstance=MyInstance}}|

h3. SQL Server Authentication Type
||Property|{{option.packdb.usagesqlauthtype}}|{{true}}/{{false}}
Install a Data Source Connection to the Yellowfin Configuration Database, and Sample Usage Reports.
Default = {{false}}|
|{{option.pack.lang.es}}|{{true}}/{{false}}
Install the Spanish Language Pack
Default = {{false}}|
|{{option.pack.lang.fr}}|{{true}}/{{false}}
Install the French Language Pack
Default = {{false}}|
|{{option.pack.lang.ja}}|{{true}}/{{false}}
Install the Japanese Language Pack
Default = {{false}}|
|{{option.pack.lang.pt}}|{{true}}/{{false}}
Install the Portuguese (Brazil) Language Pack
Default = {{false}}|
|{{option.pack.lang.zh}}|{{true}}/{{false}}
Install the Chinese Language Pack
Default = {{false}}|
{anchor:note}
_* file paths are relative to the target system being installed into_
{expand}
\\

By specifying HSQLDB as the database type ({{option.db.dbtype=HSQLDB}}) you are selecting to install into the HSQL embedded database. This will create a self-contained database in the Yellowfin installation, and all other database options are ignored ({{option.db.*}}).

An additional option is used to set the installer interface language:
|{{lang}}|Installer Interface Language|

Currently supported languages are {{en}} - English, {{ja}} - Japanese, and {{fr}} - French. If you do not specify this option, the gui installer will prompt you to select a language before launching:

!step1.png!

The command-line installer will use English as the interface language if none is selected.


h3. Example
The following is an example section from custom.properties showing the pre-selection of user options:
{code:none}
lang=en
option.serverport=8080
option.db.createdb=true
option.db.createuser=true
option.db.dbtype=SQLServer
option.db.sqlauthtype=sqlserver
option.db.hostname=localhost
option.db.port=1433
option.db.dbname=yellowfindb
option.db.username=yfuser
option.db.userpassword=yfpassword
option.db.dbausername=sa
option.db.dbapassword=
option.pack.tutorial=true
option.pack.usage=true
option.pack.lang.ja=true 
option.pack.lang.es=true
{code}
||Value|The authentication type to use when connecting to SQL Server. This property is ignored for other database types. This should be set to {{windows}} or {{sqlserver}}.|
||Default|{{sqlserver}}|
||Example|{{option.db.sqlauthtype=windows}}|

h3. SQL Server Logon Domain
||Property|{{option.db.sqldomain}}|
||Value|The logon domain to use when connecting to SQL Server with authentication type set to {{windows}}.|
||Example|{{option.db.sqldomain=MyDomain}}|

h3. Database Username
||Property|{{option.db.username}}|
||Value|The username used to connect to the Yellowfin configuration database.|
||Example|{{option.db.username=myuser}}|

h3. Database Password
||Property|{{option.db.userpassword}}|
||Value|The user password used to connect to the Yellowfin configuration database.|
||Example|{{option.db.userpassword=password}}|

h3. Create New Database User
||Property|{{option.db.createuser}}|
||Value|Set to {{true}} to create a new database user to use when connecting to the Yellowfin configuration database. This property is ignored if the selected database type does not support creating database users.|
||Example|{{option.db.createuser=true}}|

h3. Database Administrator Username
||Property|{{option.db.dbausername}}|
||Value|The database administrator username, used to connect to the database to create the database or database user. If neither of the *Create New Database* and *Create New Database User* options are set to {{true}}, this property is ignored.|
||Example|{{option.db.dbausername=admin}}|

h3. Database Administrator Password
||Property|{{option.db.dbapassword}}|
||Value|The database administrator user password, used to connect to the database to create the database or database user. If neither of the *Create New Database* and *Create New Database User* options are set to {{true}}, this property is ignored.|
||Example|{{option.db.dbapassword=password}}|

h3. Installation Folder Name
||Property|{{installer.installfolder}}|
||Value|This property sets the default name for the installation folder. In the graphical installer, the installation folder will be defaulted to a folder with this name, in an Operating System-specific location.|
||Default|{{The application name and version.}}|
||Example|{{installer.installfolder=Report Server 7.1}}|

\\
\\
{horizontalrule}
{styleclass: Class=topLink}[top|#top]{styleclass}