This documentation corresponds to a historical version of Yellowfin

Icon

Access the latest release, or view a list of available versions of the documentation.

Skip to end of metadata
Go to start of metadata

Overview

Customisation of the standard Yellowfin Login Page can be performed two ways:

  1. Simple - this involves the replacement of images, and changes to the CSS files used by the standard login page, without having to write a custom page. Generally this option is used for quick 'mock ups' but not the final restyled product.
  2. Complete - this involves writing a custom .jsp file to replace the standard page. This method requires more technical knowledge, and more time.

Simple

If you wish to create a quick, temporary custom login page, simply replace the following images in the Yellowfin ROOT directory (Yellowfin\appserver\webapps\ROOT\images) with your customised versions:

  1. logo.png
  2. yellowfin_welcome.png
  3. logoFooter.png
  4. nav_bkg.png

You will need to clear your browser cache once replacing these images in order for them to appear.

Note: the images you wish to use as replacements will need to have the same name as the files listed above in order for the page to pick them up.

Example

Component

Standard Login

Custom Login

Full Page

logo.png

yellowfin_welcome.png

logoFooter.png

nav_bkg.png

Complete

Instead of starting completely from scratch, a copy of the current login page jsp can be found in the development examples directory of your Yellowfin installation (Yellowfin\development\examples\index_mi.jsp). This will give you a starting point, providing the javascript required for the login itself, and allowing you to change the layout however required.

Instructions

Firstly, you will need to rename the login file to something other than index_mi.jsp, for example login_companyName.jsp. You will then need to place your login file in the Yellowfin ROOT directory (Yellowfin\appserver\webapps\ROOT).

In order to ensure Yellowfin uses this file instead of the standard option, you will need to complete the following while Yellowfin is not running:

  1. Stop Yellowfin
  2. Locate the web.xml file found in Yellowfin\appserver\webapps\ROOT\WEB-INF and locate the following:
    1. Update the welcome-file node to reference your new login page's name. For example:
    2. Save the changes to the web.xml.
  3. Edit your new login page, locating any references to index_mi.jsp and update to your login page name. For example:
    1. This
      Will become
    2. And this
      Will become
    3. Save the changes to your login page.
  4. In order to ensure your page is used once a user logs out, as well as the initial log in, a change needs to be made in the Yellowfin Configuration DB. In the DB:
    1. In the Configuration table, locate the record where ConfigCode = 'LOGONPAGE' and update the ConfigData = 'login_companyName.jsp' using:
  5. Restart Yellowfin

Example

Component

Standard Login

Custom Login

Full Page