Installer Look-And-Feel

Overview

All text and images used in the installer may be modified by adding properties to the custom properties file. To change a text label, simply add the replacement text as a property value. For example:

installer.title.msg=Welcome to the Yellowfin installer

All text labels displayed in the installer have an associated property in the custom properties file. See Text Properties for a list of all available text properties.

To modify images used in the installer, the appropriate image files must be added to the installer as resource files. (See インストーラーへのファイルの追加 for more information.) Then a property is added to the custom properties file that specifies the resource path within the installer. For example:

resource.pack.core.img=resources/coreicon.png

This specifies that the icon to be used to represent the "core" pack on the pack selection page has been added to the installer at the path resources/coreicon.png. Make sure resource paths are correct, as the installer will not function correctly otherwise. See Resource Locations for a list of all available resource properties.

Action properties may be added to the custom properties file. These affect either the behaviour of the installer, or the configuration of the Yellowfin Installation.

 Properties - Installer Behaviour

The following properties affect the behaviour of the installer:

Property	Value
action.nodbaccess	true/false Do not access the database in any way - only extract distribution files. The database parameters must still be set, as they will be inserted into configuration files. Default = false
action.warfileonly	true/false Extract the yellowfin.war file only - do not create any other files on the file system. The database will still be setup according to the database parameters. If this is true: 1. HSQLDB cannot be used as the database type 2. The tutorial pack cannot be installed 3. Start-menu shortcuts will not be installed Default = false
action.noshortcuts	true/false Don't create start-menu shortcuts Default = false
action.hidepacks	true/false Don't show the pack selection page. The preselected packs will automatically be installed. Default = false
action.hideserverport	true/false Don't show the App Server port option. The server port will be set based on the option.serverport value. Default = false
action.hidewinservice	true/false Don't show the Windows Service option. The service will be installed based on the option.serverport value. Default = false
action.hidedboptions	true/false Don't show the database connection options. The database connection parameters will be taken from the option.db.* options. Default = {{false
action.hideinstallpath	true/false Don't show the installation directory option. Yellowfin will be installed into the directory set by the option.installpath option.
action.nodevelopment	true/false Don't install any files under the development directory Default = false

">

 Properties - Installer Behaviour

The following properties affect the behaviour of the installer:

Property	Value
action.nodbaccess	true/false Do not access the database in any way - only extract distribution files. The database parameters must still be set, as they will be inserted into configuration files. Default = false
action.warfileonly	true/false Extract the yellowfin.war file only - do not create any other files on the file system. The database will still be setup according to the database parameters. If this is true: 1. HSQLDB cannot be used as the database type 2. The tutorial pack cannot be installed 3. Start-menu shortcuts will not be installed Default = false
action.noshortcuts	true/false Don't create start-menu shortcuts Default = false
action.hidepacks	true/false Don't show the pack selection page. The preselected packs will automatically be installed. Default = false
action.hideserverport	true/false Don't show the App Server port option. The server port will be set based on the option.serverport value. Default = false
action.hidewinservice	true/false Don't show the Windows Service option. The service will be installed based on the option.serverport value. Default = false
action.hidedboptions	true/false Don't show the database connection options. The database connection parameters will be taken from the option.db.* options. Default = {{false
action.hideinstallpath	true/false Don't show the installation directory option. Yellowfin will be installed into the directory set by the option.installpath option.
action.nodevelopment	true/false Don't install any files under the development directory Default = false

 Properties - Post-Installation Configuration

The following options affect the post-installation configuration of Yellowfin:

Property	Value
action.authentication.userid	true/false Use UserID authentication instead of email address authentication Default = false
action.adminuser.username	The username for the default Administrator user Default = admin@yellowfin.com.au
action.adminuser.password	The password for the default Administrator user Default = test
action.adminuser.email	The email address for the default Administrator user Default = admin@yellowfin.com.au
action.adminuser.firstname	The first name of the default Administrator user Default = System
action.adminuser.lastname	The last name of the default Administrator user Default = Administrator
action.config.headertype	standard/none/custom Set the type of page header Default = standard
action.config.footertype	standard/none/custom Set the type of page footer Default = standard
action.config.leftnavtype	none/custom Set the type of left navigation Default = none
action.config.standardheaderurl	Sets the header include url to use when "standard" header is used. This will override the standard Yellowfin header.
action.config.standardfooterurl	Sets the footer include url to use when "standard" footer is used. This will override the standard Yellowfin footer.
action.config.customheaderurl	Sets the header include url to use when "custom" header is used.
action.config.customfooterurl	Sets the footer include url to use when "custom" footer is used.
action.config.showtoolbar	true/false Show the toolbar Default = true
action.config.showtoolbarlogoff	true/false Show the logoff link on the toolbar Default = false
action.config.supportemail	Sets the email address to send error notification emails to. This overrides the Yellowfin support address.
action.config.appname	Sets the application name, used in some display text throughout Yellowfin. Default = Yellowfin
action.config.exportfilename	Sets the filename to save export files as. Default = YellowfinExport.xml
action.config.broadcastemail	Sets the email address to send broadcast emails from
action.config.broadcastname	Sets the from name to send broadcast emails from
action.config.ldapbinduser	Sets the LDAP bind username
action.config.ldapbindpassword	Sets the LDAP bind password
action.config.dashwidth	Sets the default dashboard width Default = 900
action.config.dashanalyticfilters	left/right Sets the default location for filters on analytic dashboards Default = right
action.config.searchlocation	top/right/off Sets the default location for the search box on the dashboard and report list pages Default = top
action.config.associatedreports	left/right/off Sets the default location for associated reports on the dashboard page Default = right
action.config.basetags	yes/no/comment Whether to include base tags in each page Default = yes
action.config.smtpserver action.config.smtpport action.config.smtpauth action.config.smtpusername action.config.smtppassword action.config.smtpssl action.config.smtpstarttls	Sets default parameters for the SMTP server used by Yellowfin

">

 Properties - Post-Installation Configuration

The following options affect the post-installation configuration of Yellowfin:

Property	Value
action.authentication.userid	true/false Use UserID authentication instead of email address authentication Default = false
action.adminuser.username	The username for the default Administrator user Default = admin@yellowfin.com.au
action.adminuser.password	The password for the default Administrator user Default = test
action.adminuser.email	The email address for the default Administrator user Default = admin@yellowfin.com.au
action.adminuser.firstname	The first name of the default Administrator user Default = System
action.adminuser.lastname	The last name of the default Administrator user Default = Administrator
action.config.headertype	standard/none/custom Set the type of page header Default = standard
action.config.footertype	standard/none/custom Set the type of page footer Default = standard
action.config.leftnavtype	none/custom Set the type of left navigation Default = none
action.config.standardheaderurl	Sets the header include url to use when "standard" header is used. This will override the standard Yellowfin header.
action.config.standardfooterurl	Sets the footer include url to use when "standard" footer is used. This will override the standard Yellowfin footer.
action.config.customheaderurl	Sets the header include url to use when "custom" header is used.
action.config.customfooterurl	Sets the footer include url to use when "custom" footer is used.
action.config.showtoolbar	true/false Show the toolbar Default = true
action.config.showtoolbarlogoff	true/false Show the logoff link on the toolbar Default = false
action.config.supportemail	Sets the email address to send error notification emails to. This overrides the Yellowfin support address.
action.config.appname	Sets the application name, used in some display text throughout Yellowfin. Default = Yellowfin
action.config.exportfilename	Sets the filename to save export files as. Default = YellowfinExport.xml
action.config.broadcastemail	Sets the email address to send broadcast emails from
action.config.broadcastname	Sets the from name to send broadcast emails from
action.config.ldapbinduser	Sets the LDAP bind username
action.config.ldapbindpassword	Sets the LDAP bind password
action.config.dashwidth	Sets the default dashboard width Default = 900
action.config.dashanalyticfilters	left/right Sets the default location for filters on analytic dashboards Default = right
action.config.searchlocation	top/right/off Sets the default location for the search box on the dashboard and report list pages Default = top
action.config.associatedreports	left/right/off Sets the default location for associated reports on the dashboard page Default = right
action.config.basetags	yes/no/comment Whether to include base tags in each page Default = yes
action.config.smtpserver action.config.smtpport action.config.smtpauth action.config.smtpusername action.config.smtppassword action.config.smtpssl action.config.smtpstarttls	Sets default parameters for the SMTP server used by Yellowfin