Overview
General System Settings
Java Path
Property |
|
---|---|
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 |
|
Application Name
Property |
|
---|---|
Value | The application name that is displayed within the application, instead of “Yellowfin”. |
Default |
|
Example |
|
Application .war File Name
Property |
|
---|---|
Value | The name of the web application archive (.war) file. |
Default |
|
Example |
|
Application Log File Name
Property |
|
---|---|
Value | The name of the application log file. Yellowfin logs to this file during normal operation. |
Default |
|
Example |
|
Base Tags Option
Property |
|
---|---|
Value | Whether <base> tags should be included in html within the Yellowfin. Should be |
Default |
|
Example |
|
Date Format
Property |
|
---|---|
Value | The default date format. Should be |
Default |
|
Example |
|
Export Filename
Property |
|
---|---|
Value | The filename used for XML content exports. |
Default |
|
Example |
|
Support Email Address
Property |
|
---|---|
Value | The support email address. Error reports can be sent to this address. |
Default |
|
Example |
|
Use UserId Authentication
Property |
|
---|---|
Value | If this is set to true, users log in with a UserId rather than an email address. |
Default |
|
Example |
|
Adding Additional Files
See Adding Files to the Application for more information.
Administrator User
Administrator Username
Property |
|
---|---|
Value | The login username for the initial administrator user account. |
Default |
|
Example |
|
Administrator User Password
Property |
|
---|---|
Value | The password for the initial administrator user account. |
Default |
|
Example |
|
Administrator User First Name
Property |
|
---|---|
Value | The first name for the initial administrator user account. |
Default |
|
Example |
|
Administrator User Last Name
Property |
|
---|---|
Value | The last name for the initial administrator user account. |
Default |
|
Example |
|
Administrator User Email Address
Property |
|
---|---|
Value | The email address for the initial administrator user account. |
Default |
|
Example |
|
LDAP Settings
LDAP Bind Username
Property |
|
---|---|
Value | The default LDAP bind username. |
Example |
|
LDAP Bind Password
Property |
|
---|---|
Value | The default LDAP bind password. |
Example |
|
Broadcast Email
Broadcast Email Address
Property |
|
---|---|
Value | The email address that broadcast emails will be sent from. |
Default |
|
Example |
|
Broadcast Email Name
Property |
|
---|---|
Value | The from name for broadcast emails. |
Default |
|
Example |
|
SMTP Server
Following are the SMTP Server properties.
To learn how to configure an SMTP server, refer to this section.
SMTP Server Hostname
Property |
|
---|---|
Value | The hostname of the smtp server to send mail through. |
Example |
|
SMTP Server Port
Property |
|
---|---|
Value | The smtp server port. |
Example |
|
SMTP Server SSL Option
Property |
|
---|---|
Value | Set this to |
Default |
|
Example |
|
SMTP Server StartTLS Option
Property |
|
---|---|
Value | Set this to |
Default |
|
Example |
|
SMTP Server Authentication
Property |
|
---|---|
Value | Set this to |
Default |
|
Example |
|
SMTP Server Username
Property |
|
---|---|
Value | The username used when authenticating with the SMTP server. |
Example |
|
SMTP Server Password
Property |
|
---|---|
Value | The password used when authenticating with the SMTP server. |
Example |
|
Dashboard Settings
Dashboard Width
Property |
|
---|---|
Value | The default dashboard width in pixels. |
Default |
|
Example |
|
Dashboard Associated Reports Location
Property |
|
---|---|
Value | The position of associated reports on dashboards. Should be |
Default |
|
Example |
|
Dashboard Analytic Filter Location
Property |
|
---|---|
Value | The default position of analytic filters on dashboards. Should be |
Example |
|
Dashboard Search Location
Property |
|
---|---|
Value | The position of the search box on the dashboard page. Should be |
Default |
|
Example |
|
Navigation Settings
Show Toolbar
Property |
|
---|---|
Value | Set to |
Default |
|
Example |
|
Show Logoff Link on Toolbar
Property |
|
---|---|
Value | Set to |
Default |
|
Example |
|
Integration Settings
Custom Index Page
Property |
|
---|---|
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.
|
Example |
|
Header Type
Property |
|
---|---|
Value | The header type to use. Should be |
Default |
|
Example |
|
Standard Header URL
Property |
|
---|---|
Value | Override the header used when the header type is |
Example |
|
Custom Header URL
Property |
|
---|---|
Value | The URL used when the header type is |
Example |
|
Footer Type
Property |
|
---|---|
Value | The footer type to use. Should be |
Default |
|
Example |
|
Standard Footer URL
Property |
|
---|---|
Value | Override the footer used when the footer type is |
Example |
|
Custom Footer URL
Property |
|
---|---|
Value | The URL used when the footer type is |
Example |
|
Best Practice Tips
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\^.
This is especially important for ‘reserved’ characters (i.e. characters that have a special meaning in the command terminal, such as <, >, @, |, &, “, and more) and practices that pass values in double quotes. In case of the quotes, the system will assume that the mid-password quote is the closing quote, thereby ignoring the remaining value.