General structure
Once you have installed Yellowfin on your system, an application/program folder will be created for the instance. This page discusses the main files and folders that will be present within that folder.
Your new Yellowfin directory contains some useful information and resources. The table below outlines the most useful.
| Directory Path or File | Content Description |
|---|---|
| \appserver | This folder contains Apache Tomcat Java application server binaries, scripts and configuration files. |
| \appserver\bin | Yellowfin/Tomcat startup and shutdown scripts. |
| \appserver\conf | Tomcat configuration files including server.xml. |
| \appserver\logs | Yellowfin and Tomcat log files. |
| \appserver\webapps\ROOT | Yellowfin web application server binaries, scripts and configuration files (see table below for further details). |
| \data | Default Yellowfin configuration database properties and script files. |
| \development | Yellowfin development libraries, documentation and sample code. |
| \development\doc\webservices\javadoc | Documentation for Yellowfin web services. |
| \doc | Empty folder reserved for future use. |
| \legal | Yellowfin and third-party license agreements and notes. |
| \tutorialdata | Ski Team tutorial database files. |
| \Uninstaller | A program to uninstall Yellowfin from your system. |
| \yellowfin.war | Yellowfin web application archive used by Apache Tomcat Java application server. |
| \YellowfinInstallLog-YYYYMMDD.log | A log file created by the Yellowfin installer (see Logs and Logging for more info). |
The ROOT directory
The ROOT folder within \appserver\webapps contains some of the web application's main scripts and files.
The table below describes some of the most useful content, which you will need to access if you wish to customize or add to your default Yellowfin deployment.
| Directory Path or File | Content Description |
|---|---|
| \customcss | Place custom css files in this directory. Any files in this directory with a .css extension will be included in all pages. |
| \customimages | Place custom image files in this directory. Any files in this directory will override files in the images directory with the same name. |
| \js\chartingLibraries | Additional JavaScript chart libraries can be placed here. |
| \revisions.json | Version information about the Yellowfin build. |
| \WEB-INF\custom-functions.xml | Custom SQL functions can be added to this file. |
| \WEB-INF\lib | Additional JDBC drivers can be placed here. |
| \WEB-INF\log4j.properties | The Yellowfin logging level can be set in this file. |
| \WEB-INF\web.xml | Main Yellowfin web application configuration file. |
Log file location
Yellowfin can log as little or as much detail as required for a range of purposes. For detailed information on the location and content of log files, see the Logs and Logging page.
Section navigation
Current topic - Deploy Yellowfin
This page is part of the Install And Deploy Yellowfin section of the wiki, which has these topics: