Setting the Current Locale in the Oracle BI Server

Learn more about the various ways to customize localizations in the application.

The following sections provide information about setting the locale in Oracle BI Server:

Setting Locale Parameters on the Oracle BI Server

To support multiple languages, the Oracle BI Server must be configured properly.

The General section of the NQSConfig.INI file contains parameters that are required for localization and internationalization. It also contains default parameters that determine how data is sent from the Oracle BI Server to a client application. See Configuration File Settings.

The following parameters in the NQSConfig.INI file affect localization:

  • LOCALE

  • SORT_ORDER_LOCALE

  • SORT_TYPE

  • CASE_SENSITIVE_CHARACTER_COMPARISON

To successfully run Oracle Business Intelligence, ensure that you configure the appropriate locales on your operating system for the language in which users run the applications. Some locale- and language-related settings are interrelated and help determine how the Oracle BI Server sorts data.

Setting the Locale on UNIX Systems

The value to use for the C-runtime locale during server startup is specified in the SORT_ORDER_LOCALE parameter in the NQSConfig.INI file. This parameter is set normally by the Oracle BI Server.

The locale is used for functions such as displaying dates and currencies and sorting data.

If you must adjust the setting, then in the General section of the NQSConfig.INI file, set the LOCALE and SORT_ORDER_LOCALE parameters, entering a platform-independent name.

The following table shows language mappings from the platform-independent name to the specific name for each of the supported UNIX platforms. For example, Chinese uses the setting zh_CN.utf8 on HP-UX or Linux operating systems.

Name strings such as zh_CN.utf8 and fr-FR-UTF-8 are the platform-specific names of the locale components, which must be installed by a system administrator. The NQSConfig.INI file uses the platform-independent names, such as Chinese or French (the names are case-insensitive).

Locale (Platform-Independent Name) Name on Solaris Name on AIX Name on HP-UX/Linux

Arabic

ar_SA.UTF-8

AR_AA.UTF-8

ar_SA.utf8

Chinese

zh_CN.UTF-8

ZH_CN.UTF-8

zh_CN.utf8

Chinese-traditional

zh_TW.UTF-8

ZH_TW.UTF-8

zh_TW.utf8

Croatian

hr_HR.UTF-8

HR_HR.UTF-8

hr_HR.utf8

Czech

cs_CZ.UTF-8

CS_CZ.UTF-8

cs_CZ.utf8

Danish

da_DK.UTF-8

DA_DK.UTF-8

da_DK.utf8

Dutch

nl_NL.UTF-8

NL_NL.UTF-8

nl_NL.utf8

English-USA

en_US.UTF-8

EN_US.UTF-8

en_US.utf8

Finnish

fi_FI.UTF-8

FI_FI.UTF-8

fi_FI.utf8

French

fr_FR.UTF-8

FR_FR.UTF-8

fr_FR.utf8

German

de_DE.UTF-8

DE_DE.UTF-8

de_DE.utf8

Greek

el_GR.UTF-8

EL_GR.UTF-8

el_GR.utf8

Hebrew

he_IL.UTF-8

HE_IL.UTF-8

iw_IL.utf8

Hungarian

hu_HU.UTF-8

HU_HU.UTF-8

hu_HU.utf8

Italian

it_IT.UTF-8

IT_IT.UTF-8

it_IT.utf8

Japanese

ja_JP.UTF-8

JA_JP.UTF-8

ja_JP.utf8

Korean

ko_KR.UTF-8

KO_KR.UTF-8

ko_KR.utf8

Norwegian

no_NO.UTF-8

NO_NO.UTF-8

no_NO.utf8

Polish

pl_PL.UTF-8

PL_PL.UTF-8

pl_PL.utf8

Portuguese

pt_PT.UTF-8

PT_PT.UTF-8

pt_PT.utf8

Portuguese-Brazilian

pt_BR.UTF-8

PT_BR.UTF-8

pt_BR.utf8

Romanian

ro_RO.UTF-8

RO_RO.UTF-8

ro_RO.utf8

Russian

ru_RU.UTF-8

RU_RU.UTF-8

ru_RU.utf8

Slovak

sk_SK.UTF-8

SK_SK.UTF-8

sk_SK.utf8

Spanish

es_ES.UTF-8

ES_ES.UTF-8

es_ES.utf8

Swedish

sv_SE.UTF-8

SV_SE.UTF-8

sv_SE.utf8

Thai

th_TH.UTF-8

TH_TH.UTF-8

th_TH.utf8

Turkish

tr_TR.UTF-8

TR_TR.UTF-8

tr_TR.utf8

Understanding How the Error Message Language Is Determined

For Oracle BI Presentation Services, the error message language is set based on the NQ_SESSION.WEBLANGUAGE session variable.

Presentation Services provides a default value for this variable upon installation. The value is updated when a user selects a language on the Oracle BI EE sign-in page.

For other clients, including third-party clients, the error message language is determined by the following precedence model:

  • The error message language is set based on the WEBLANGUAGE session variable.

  • If the WEBLANGUAGE session variable is not set, then the error message language is based on the error language that is specified in the ODBC Data Source Name (DSN) that is used to access the Oracle BI Presentation Services.

    See Integrator's Guide for Oracle Business Intelligence Enterprise Edition for information about setting the error message language in the ODBC DSN.

  • If an error message language has not been set in the ODBC DSN, then the language that is specified in the ORACLE_BI_LANG environment variable is used for error messages.

    To change the value of ORACLE_BI_LANG, update the character code for this variable in NQSConfig.INI. You can view the character codes for supported languages in the ORACLE_HOME/bi/bifoundation/server/locale directory (for example, "en" for English, or "pt-BR" for Portuguese/Brazilian).

  • If the ORACLE_BI_LANG environment variable is not set, then error messages are displayed in English.

Note that clients for the Administration Tool and Job Manager do not set the WEBLANGUAGE session variable. Therefore, these clients follow the precedence model starting with the ODBC DSN error message setting.

Setting the Language for Components of the Oracle BI Server

The ORACLE_BI_LANG variable controls which language is used to present components of the application to the user.

To display the correct language for components in the Oracle BI Server, including the contents of the NQServer.log file, you must set the ORACLE_BI_LANG variable, as described in the following procedure.

  1. Open the NQSConfig.INI file for editing at:

    BI_DOMAIN/config/fmwconfig/biconfig/OBIS

  2. Insert a line to set the ORACLE_BI_LANG environment variable. The following example shows the language being set to Japanese:

    <variable id="ORACLE_BI_LANG" value="ja"/>

  3. Save your changes and close the file.
  4. Restart BI system components and the BI Server.

Modifying the Language of the User Interface for the Administration Tool

The user interface of the Oracle BI Administration Tool inherits the language that is specified for the operating system.

For example, if the Windows operating system is set to use the French language, then all user interface elements such as menus and buttons are displayed in French in all Windows-based applications such as Notepad and the Administration Tool. The locale that you set in the Windows Control Panel affects items such as currency, dates and times, units displayed, and keyboard layout, which differ from user interface elements such as menus and buttons.

The recommended approach is to allow the Administration Tool to inherit the language from the operating system. If you must change the language for the user interface of the Administration Tool without changing the operating system language, then you can use the ORACLE_BI_LANG environment variable for this purpose. For information on setting that variable, see Understanding How the Error Message Language Is Determined.

You can also localize the names of subject areas, tables, hierarchies, columns, and their descriptions in the Presentation layer, as described in Localizing Metadata Names in the Repository.

Troubleshooting the Current Locale in the Oracle BI Server

Some locations require specific troubleshooting procedures.

This section provides the following information about troubleshooting the current locale in the Oracle BI Server:

Handling the NLS Locale Not Supported Error Message

If you do not have the appropriate locale installed, then the Oracle BI Server does not start, and the obis1-query.log file contains the following error:

NLS locale xxx is not supported by the operating system.

where xxx is the locale that is specified in the NQSConfig.INI file for the SORT_ORDER_LOCALE parameter. Take the following actions to resolve this error:

  • UNIX. Install the locale that is indicated in the table displayed in Setting the Locale on UNIX Systems for the requested language.

  • Windows. Add the corresponding language pack using the Regional Settings dialog.

Setting the Japanese Locale on AIX Systems

AIX systems do not always interpret Japanese localization properly.

When using a Japanese localization on an AIX platform, you might discover that the Oracle BI Server does not start. If you encounter this issue, then use the following procedure.

  1. Ensure that the JA_JP.UTF-8 locale is installed. If it is not, then install it.
  2. Open the NQSConfig.INI file for editing at:

    BI_DOMAIN/config/fmwconfig/biconfig/OBIS

  3. In the General section, set the following parameters, being aware that the settings are case-sensitive:
    • LOCALE = "Japanese";

    • SORT_ORDER_LOCALE = "Japanese";

  4. Save and close the NQSConfig.INI file.

Ensuring That Text for Oracle BI Server Utilities is Displayed in the Correct Language

Ensure that usage information and error messages for the Oracle BI Server utilities are displayed in the correct language.

  • For Linux environments, set the terminal encoding to UTF-8 to display multibyte characters. To do this, select the Terminal menu, then select Set Character encoding, then select utf8.

  • For native Windows environments, set the font of the console to Lucida Console. If this option is not displayed in the list, then first change the code page to 65001, which supports UTF-8, using the command chcp 65001.

Modifying the Metadata Repository When the Underlying Oracle Database NLS_CHARACTERSET Is Not Unicode

When the NLS_CHARACTERSET in the Oracle Database is set to a non-unicode derived code page, you must configure an additional metadata repository setting to make character sorting consistent between the Oracle Database and the Oracle BI Server.

  1. In the Administration Tool, open the metadata repository.
  2. Expand the database object in the physical layer.
  3. Open the Connection Pool dialog Connection Scripts tab, and add the following new connection pool script:

    alter session set NLS_SORT = unicode_binary

  4. Save the repository, and restart the Oracle BI Server.