Overview
These properties modify the default configuration of the Yellowfin installation, post-install.General System Settings
Java Path
Property | option.javahome
|
---|
Value | The location of the java installation that should be used to run Yellowfin. If this is not set, the java installation used to run the installer will be used. |
---|
Example | option.javahome=/usr/lib/jvm/java-6-sun
|
---|
Application Name
Property | action.config.appname
|
---|
Value | The application name that is displayed within the application, instead of “Yellowfin”. |
---|
Default | Yellowfin
|
---|
Example | action.config.appname=BI Blue
|
---|
Application .war File Name
Property | installer.warfilename
|
---|
Value | The name of the web application archive (.war) file. |
---|
Default | yellowfin.war
|
---|
Example | installer.warfilename=reports.war
|
---|
Application Log File Name
Property | installer.applogfilename
|
---|
Value | The name of the application log file. Yellowfin logs to this file during normal operation. |
---|
Default | yellowfin.log
|
---|
Example | installer.applogfilename=reports.log
|
---|
Base Tags Option
Property | action.config.basetags
|
---|
Value | Whether <base> tags should be included in html within the Yellowfin. Should be YES , NO or COMMENT |
---|
Default | COMMENT
|
---|
Example | action.config.basetags=NO
|
---|
Date Format
Property | action.config.dateformat
|
---|
Value | The default date format. Should be DMY , MDY or YMD . |
---|
Default | DMY
|
---|
Example | action.config.dateformat=MDY
|
---|
Export Filename
Property | action.config.exportfilename
|
---|
Value | The filename used for XML content exports. |
---|
Default | YellowfinExport.xml
|
---|
Example | action.config.exportfilename=BIExport.xml
|
---|
Support Email Address
Property | action.config.supportemail
|
---|
Value | The support email address. Error reports can be sent to this address. |
---|
Default | support@yellowfin.com.au
|
---|
Example | action.config.supportemail=support@example.com
|
---|
Use UserId Authentication
Property | action.authentication.userid
|
---|
Value | If this is set to true, users log in with a UserId rather than an email address. |
---|
Default | false
|
---|
Example | action.authentication.userid=true
|
---|
Adding Additional Files
See Adding Files to the Application for more information.
Administrator User
Administrator Username
Property | action.adminuser.username
|
---|
Value | The login username for the initial administrator user account. |
---|
Default | admin@yellowfin.com.au
|
---|
Example | action.adminuser.username=adminuser
|
---|
Administrator User Password
Property | action.adminuser.password
|
---|
Value | The password for the initial administrator user account. |
---|
Default | test
|
---|
Example | action.adminuser.password=secret
|
---|
Administrator User First Name
Property | action.adminuser.firstname
|
---|
Value | The first name for the initial administrator user account. |
---|
Default | System
|
---|
Example | action.adminuser.firstname=Joe
|
---|
Administrator User Last Name
Property | action.adminuser.lastname
|
---|
Value | The last name for the initial administrator user account. |
---|
Default | Administrator
|
---|
Example | action.adminuser.lastname=Smith
|
---|
Administrator User Email Address
Property | action.adminuser.email
|
---|
Value | The email address for the initial administrator user account. |
---|
Default | admin@yellowfin.com.au
|
---|
Example | action.adminuser.lastname=admin@example.com
|
---|
LDAP Settings
LDAP Bind Username
Property | action.config.ldapbinduser
|
---|
Value | The default LDAP bind username. |
---|
Example | action.config.ldapbinduser=username
|
---|
LDAP Bind Password
Property | action.config.ldapbindpassword
|
---|
Value | The default LDAP bind password. |
---|
Example | action.config.ldapbindpassword=secret
|
---|
Broadcast Email
Broadcast Email Address
Property | action.config.broadcastemail
|
---|
Value | The email address that broadcast emails will be sent from. |
---|
Default | no-reply@yellowfin.com.au
|
---|
Example | action.config.broadcastemail=reports@example.com
|
---|
Broadcast Email Name
Property | action.config.broadcastname
|
---|
Value | The from name for broadcast emails. |
---|
Default | Yellowfin Reports
|
---|
Example | action.config.broadcastname=BI Blue Reports
|
---|
SMTP Server
SMTP Server Hostname
Property | action.config.smtpserver
|
---|
Value | The hostname of the smtp server to send mail through. |
---|
Example | action.config.smtpserver=mail.example.com
|
---|
SMTP Server Port
Property | action.config.smtpport
|
---|
Value | The smtp server port. |
---|
Example | action.config.smtpport=465
|
---|
SMTP Server SSL Option
Property | action.config.smtpssl
|
---|
Value | Set this to true to use SSL when connecting to the SMTP server. |
---|
Default | false
|
---|
Example | action.config.smtpssl=true
|
---|
SMTP Server StartTLS Option
Property | action.config.smtpstarttls
|
---|
Value | Set this to true to use the StartTLS command when connecting to the SMTP server. |
---|
Default | false
|
---|
Example | action.config.smtpstarttls=true
|
---|
SMTP Server Authentication
Property | action.config.smtpauth
|
---|
Value | Set this to true to use authentication when connecting to the SMTP server. |
---|
Default | false
|
---|
Example | action.config.smtpauth=true
|
---|
SMTP Server Username
Property | action.config.smtpusername
|
---|
Value | The username used when authenticating with the SMTP server. |
---|
Example | action.config.smtpusername=username
|
---|
SMTP Server Password
Property | action.config.smtppassword
|
---|
Value | The password used when authenticating with the SMTP server. |
---|
Example | action.config.smtppassword=secret
|
---|
Dashboard Settings
Dashboard Width
Property | action.config.dashwidth
|
---|
Value | The default dashboard width in pixels. |
---|
Default | 1000
|
---|
Example | action.config.dashwidth=800
|
---|
Dashboard Associated Reports Location
Property | action.config.associatedreports
|
---|
Value | The position of associated reports on dashboards. Should be RIGHT or OFF . |
---|
Default | RIGHT
|
---|
Example | action.config.associatedreports=OFF
|
---|
Dashboard Analytic Filter Location
Property | action.config.dashanalyticfilters
|
---|
Value | The default position of analytic filters on dashboards. Should be LEFT or RIGHT . |
---|
Example | action.config.dashanalyticfilters=RIGHT
|
---|
Dashboard Search Location
Property | action.config.searchlocation
|
---|
Value | The position of the search box on the dashboard page. Should be TOP , RIGHT or OFF . |
---|
Default | TOP
|
---|
Example | action.config.searchlocation=RIGHT
|
---|
Navigation Settings
Show Toolbar
Property | action.config.showtoolbar
|
---|
Value | Set to false to disable the application toolbar on all pages. |
---|
Default | true
|
---|
Example | action.config.showtoolbar=false
|
---|
Show Logoff Link on Toolbar
Property | action.config.showtoolbarlogoff
|
---|
Value | Set to false to disable the logoff link on the application toolbar. |
---|
Default | true
|
---|
Example | action.config.showtoolbarlogoff=false
|
---|
Integration Settings
Custom Index Page
Property | action.customindexpage
|
---|
Value | The location of a custom index page. This property points to a resource within the installer archive. The file will be extracted and used as the index page. See Adding Files to the Installer for more information.
|
---|
Example | action.customindexpage=resources/index.html
|
---|
Header Type
Property | action.config.headertype
|
---|
Value | The header type to use. Should be STANDARD , CUSTOM or NONE . |
---|
Default | STANDARD
|
---|
Example | action.config.headertype=NONE
|
---|
Standard Header URL
Property | action.config.standardheaderurl
|
---|
Value | Override the header used when the header type is STANDARD . This may be an absolute or relative URL. |
---|
Example | action.config.standardheaderurl=header.html
|
---|
Custom Header URL
Property | action.config.customheaderurl
|
---|
Value | The URL used when the header type is CUSTOM . This may be an absolute or relative URL. |
---|
Example | action.config.customheaderurl=header.html
|
---|
Footer Type
Property | action.config.footertype
|
---|
Value | The footer type to use. Should be STANDARD , CUSTOM or NONE . |
---|
Default | STANDARD
|
---|
Example | action.config.footertype=NONE
|
---|
Standard Footer URL
Property | action.config.standardfooterurl
|
---|
Value | Override the footer used when the footer type is STANDARD .This may be an absolute or relative URL. |
---|
Example | action.config.standardfooterurl=footer.html
|
---|
Custom Footer URL
Property | action.config.customfooterurl
|
---|
Value | The URL used when the footer type is CUSTOM . This may be an absolute or relative URL. |
---|
Example | action.config.customfooterurl=footer.html
|
---|