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

Yellowfin has internationalisation and localisation capability. This means that Yellowfin can be deployed in multiple languages and supports double byte character sets. Details on the steps required to localise Yellowfin for your particular language installation will be outlined.

How it works

Yellowfin uses Struts internationalisation for its process. (See http://www.exadel.com/tutorial/struts/5.2/strutstutorials-i18n.html for more details).
Text within the JSP has a <bean:message key="key"/> tag. See example from the dashboard jsp below.

The bean then references the resources file for the message key mi.text.tab=Add Tab
The language code specified within the bundle allows multiple languages to be deployed within a single site. Yellowfin will detect the users default browser language setting and display text accordingly.

Login Page

The login page is usually configured per installation as a result Yellowfin has not internationalised this page. You will have access to the JSP and can create your own look and feel which would include localisation as required.

If using single-sign on you will by-pass the login page and as a result will not need to edit this jsp at all.

Default PDF Font Setting

Yellowfin can export report data to PDF files. For double byte character sets the customer must choose the default PDF export fonts. Since the font will be embedded in the PDF. This font can differ from the output font that is displayed on the screen. The end user may have the option to change these fonts (eg there are 4 Chinese variations).

  1. If using Chinese, Korean or Japanese font sets for report out put you will have to select a default font set for PDF export.
  2. Navigate to the Administration panel and click the configuration link.
  3. Select the PDF from type from the default drop down list.
  4. If you wish to enable your users to change the font at the time of printing the report set the allow users to change to 'Yes'

Language Translations

All displayed text within Yellowfin - excluding your own content can be translated based on the users browser settings. This is achieved via two mechanisms - management of the application resource file - which is used predominantly for display text, and the Yellowfin reference code tables which are generally used for drop down menus.

Installation

When installing Yellowfin you will be presented with the option to include language translations other than English:

If these are selected the languages will automatically be available to users, all they will need to do is ensure their browser default language settings are set to the language they wish Yellowfin to display in.

Note: these translations only apply to the Yellowfin interface text, not the data returned in your charts and reports.

Resource File Management

In the directory Yellowfin/webapps/ROOT/WEB-INF, create the directory structure classes/com/hof.

  1. Copy the Application Resource file - Eg. for Japanese - ApplicationResource_ja.properties into the hof directory.
  2. Restart Yellowfin, and the Japanese translations will become available.
    The translations shown are based on the settings of your browser; this allows multiple translations off the same instance of Yellowfin.

Yellowfin Reference Codes

Yellowfin generally maintains a localized translation for its internal reference codes of all its supported languages. However if you wish to update these manually you can do so by updating the ReferenceCodeDescription table directly.

In this table you will see the short and long description for each reference code used within the application, and a language code for specific languages. Generally only the short description is displayed. Update the short description to change the displayed text.

For more information on Yellowfin's language settings, see the Yellowfin Forum post: http://www.yellowfinbi.com/YFForum-Yellowfin-in-a-multi-language-environment-?thread=106301

Local Date Format

A configuration option exists within Yellowfin to determine the default date format that is used throughout the application.

For example Yellowfin comes with a standard date format of day/month/year. However, your local custom is to use month/day/year.

By updating the configuration item your users will always be presented with dates in the preferred format.

  1. To update the date format access the administration > configuration form.
  2. Set the date format using the options available.

Name Format

To configure the default name format you can change the order in which names are printed out on the page.
Select the name format that is appropriate for your local.

Decimal & Thousand Separator

To configure the default decimal and thousand separator formats select the name format that is appropriate for your local.