Like what you see? Have a play with our trial version.

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

These properties modify the default configuration of the Yellowfin installation, post-install.


General System Settings

Styleclass
ClasstopLink

top


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

...

See Adding Files to the Application for more information.

Administrator User

...

ClasstopLink

...

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

...

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

...

...

top

LDAP Bind Username

Property

action.config.ldapbinduser

Value

The default LDAP bind username.

Example

action.config.ldapbinduser=username

...

Property

action.config.ldapbindpassword

Value

The default LDAP bind password.

Example

action.config.ldapbindpassword=secret

Broadcast Email

Styleclass
ClasstopLink

top

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

...

Property

action.config.broadcastname

Value

The from name for broadcast emails.

Default

Yellowfin Reports

Example

action.config.broadcastname=BI Blue Reports

SMTP Server

Styleclass
ClasstopLink

top


Following are the SMTP Server properties. 

Tip

To learn how to configure an SMTP server, refer to this section.


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

...

Property

action.config.smtppassword

Value

The password used when authenticating with the SMTP server.

Example

action.config.smtppassword=secret

Dashboard Settings

...

...

ClasstopLink

...

top


Dashboard Width

Property

action.config.dashwidth

Value

The default dashboard width in pixels.

Default

1000

Example

action.config.dashwidth=800

...

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

...

ClasstopLink

...

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

...

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

...

...

top

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

...

Styleclass
ClasstopLink

top




Best Practice Tips

...

ClasstopLink

...


When running terminal commands, be vary of values using special characters. For instance, if your password contains a special character such as a double quote or an asterisk, then you must escape the character by using the backslash character right before it. So if your password is regional”5^, then you must type in regional\”5\^.

...