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.
Comment: Migration of unmigrated content due to installation of a new plugin

...

Table of Contents
classcontents

web.xml


Styleclass
ClasstopLink

...

20709447

The web.xml file provides configuration and deployment information for the Yellowfin application. The Yellowfin web.xml file is located in the directory:
Yellowfin\appserver\webapps\ROOT\WEB-INF
A number of installation-specific settings are stored in web.xml when Yellowfin is installed. These settings are critical to Yellowfin starting and running successfully.

...

JDBCDriverClass

The name of the JDBC Driver class

Required

JDBCUrl

The JDBC URL to connect to the database

Required

JDBCUser

The username used to connect

Required

JDBCPassword

The password used to connect

Required

JDBCPasswordEncrypted

Whether or not the password in JDBCPassword is encrypted. (true/false)

Optional (Defaults to false)

JDBCMinCount

The minimum number of connections to open to the database

Required

JDBCMaxCount

The maximum number of connections to open to the database

Required

JDBCTimeout

How long a connection may be in use for before being closed (in seconds)

Optional (Defaults to 300)

PSCacheSize

How many Prepared Statements to cache per connection (maximum). Setting this to zero disables Prepared Statement caching.

Optional (Defaults to 20)

For more information, see the Yellowfin Forum post: http://www.yellowfinbi.com/YFForum-Connecting-to-the-Yellowfin-Repository-DB-?thread=105090


General Yellowfin startup parameters

...

ReportCacheSize

Number of result sets to store in the report result cache

Optional (Defaults to 20)

ReportCacheMaxAge

The maximum age of result sets in the report result cache (in milliseconds)

Optional (Defaults to 24 hours)

BIRTPath

The path to the BIRT support files

Optional

ScanJarFiles

Whether or not to scan for JDBC drivers at startup (true/false)

Optional (Defaults to true)

JDBCDrivers

JDBC driver class names to search for at startup, separated by commas. If ScanJarFiles is false, use this to specify the available drivers.

Optional

Clustering


Styleclass
ClasstopLink

...

20709447

Clustering allows Yellowfin to be run on multiple servers off the same database. In order to cluster Yellowfin, the following will need to be added into the web.xml file, with your web services information filled in.

...

  1. If changes are made to ref codes on one server, all other servers reload their ref codes.
  2. If a view is changed, the old version will be removed from the cache of all servers.
  3. If a new licence is uploaded, all servers are updated.
    Note: You will need to ensure your licence lists all the required hostnames, which you will have to contact Yellowfin for (sales@yellowfin.bi).

Performance Tuning


Styleclass
ClasstopLink

...

20709447

Other than increasing hardware capacity, e.g. faster CPU and memory allocation, there are a number of ways that Yellowfin can be performance tuned. For more information on capacity and configuration settings please refer to the server capacity white paper.

...

  1. Open the Command Prompt and change to the appserver\bin directory under the Yellowfin installation directory.
  2. Run the command: tomcat5wtomcat8w.exe //ES//Yellowfin

    This will run the service manager for the Yellowfin service. Go to the "Java" tab, and change the "Initial memory pool" and "Maximum memory pool" values:
  3. Restart the Yellowfin service to pick up the changes.

...

  1. Shut down Yellowfin
  2. Edit the file Yellowfin/appserver/bin/catalina.sh
  3. Find the section:

    Code Block
    none
    none
    # Memory limits.
    # Use these options to set the Java memory limits.
    # -Xms64m sets the initial Java heap size to 64Mb
    # -Xmx256m sets the maximum Java heap size to 256Mb
    #JAVA_OPTS="$JAVA_OPTS -Xms64m -Xmx256m"
    


  4. Uncomment the last line, and change the Xmx option to your desired max memory setting.
  5. Restart Yellowfin to pick up the changes.

For more information on Performance, see the Yellowfin Forum post: http://www.yellowfinbi.com/YFForum-General-questions-on-performance-?thread=104626

 

horizontalrule

Styleclass
ClasstopLink

...

20709447