Multilingual Switchover for the Platform

Version

Application Scenario

In some enterprises, different departments work with different languages. To meet the needs of each department, a multilingual system needs to be established, as shown in the following figure.

Function Description

The language of the FineReport decision-making platform can be switched in the following two modes:

• One-click switchover: applicable to System Management and Login Page.

• Key-value switchover: applicable to parts of the system with custom names, such as the platform directory name, platform title, and mobile server.

This document demonstrates how to switch the language of the decision-making system with a simple example.

Prerequisite

You have installed the Multi-language Solution plugin at https://community.finereport.com/plugin/?id=117.

For details about how to install the plugin in the designer, see Designer Plugin Management.

Switch the language of decision-making system to Japanese. The language switchover is valid for the System Management page, the Test directory, sub directories and sub-templates under this directory, the platform title, and the mobile server name.

Implementation Method

Set the platform title and custom directory names, template names, and the mobile server name as keys, and their corresponding Japanese as values.

After one-click platform language switchover, the language of the System Management page and custom keys will also be switched.

Preparation

Adding Directories and Templates

Log in to the decision-making system as the admin, choose System Management > Directory Management, and add directories and templates. For details, see Directory Management.

Modifying the Platform Title

Log in to the decision-making system as the admin, choose System Management > Appearance Configuration > Platform Style, and modify the platform title to けっていシステム, as shown in the following figure.

Modifying the Mobile Server Name

Log in to the decision-making system as the admin, choose System Management > Mobile Platform > App Config, and modify the server name to いどうたんし, as shown in the following figure.

Disabling Browser Cache

Note:

If the Disable Browser Cache option is disabled, the language of the System Management page cannot be switched. For details, see section "Internationalization Settings of System Management."

Log in to the decision-making platform as the admin, choose System Management > Security Management > Security, and enable Security Headers. Click Advanced Setting. The Disable Browser Cache switch is enabled automatically.  

Adding Keys and Corresponding Values

Log in to the decision-making system as the admin, choose System Management > Language Configuration. Click Add, and enter keys and their Japanese translation respectively in the text box of Key and Japanese, as shown in the following figure.

Note:

1. The value of Key cannot be empty or duplicate, and must be translated into at least one language. The translation should be entered in the text box of the corresponding language.

2. If you fail to add keys and values after the FineReport project is migrated to Oracle or SQL Server, you can update the driver packages of Oracle to ojdbc7.jar and SQL Server to sqljdbc42.jar.

The following table lists examples of keys and their corresponding Japanese translation.

Note:

After switchover to a certain platform language, keys without internationalized values remain original values, and keys with internationalized values will be switched to the corresponding translation.

Language Switchover

Click English in the upper right corner and select 日本語 from the drop-down list to switch the system language to Japanese, as shown in the following figure.

Effect Preview

The language of both the System Management page and the platform title is switched to Japanese, as shown in the following figure.

After clicking Directory, you can view the names of the added directories and templates displayed in Japanese, as shown in the following figure.

The following figure shows the app page after you log in to the decision-making system through the Data Analyst app, as shown in the following figure.

• The server name is displayed as いどうたんし.

• The names of the added directories and templates are displayed in Japanese.

Language Configuration

Key-Value Management

Log in to the decision-making system as the admin and choose System Management > Language Configuration to go to the internationalization setting page.

You can view, add, delete, edit, search, batch-import, batch-export, back up, and roll back keys and values on this page.

Note:

1. Remarks are not covered in the search range.

2. The Clear List button only appears when all keys are selected by ticking Key.

Key-Value Batch Import

Create an Excel as the data source. The headers of the Excel must follow the specified format shown in the following figure. Otherwise, the import fails.

Click Import on the decision-making platform and select the data source, as shown in the following figure.

Note:

The Multilingual Solution plugin of versions earlier than 2.0.7 only supports Excel in XLS format, while later versions support Excel in XLS and XLSX format.

Key-Value Batch Export

Choose System Management > Language Configuration > Export > Export Excel to export keys and values in batches, as shown in the following figure.

Backup and Rollback

Click Backup. A backup success prompt pops up, indicating that the current keys and values have been backed up.

Click Rollback. A backup restoration success prompt pops up, indicating that the backup has been restored, as shown in the following figure.

Platform Language Preference

Log in to the decision-making system as the admin, and choose System Management > Language Configuration > More Configurations to set the platform language preference, as shown in the following figure.

• Platform Language Preference: The system will be displayed in the preferred language for every user upon login. The setting will take effect after server restart.

• Platform-Supported Language: You can select languages supported by the system.

Note:

1. The system supports Simplified Chinese, Traditional Chinese, English, Japanese, and Korean.

2. To use the language switchover function on the login page, the platform language preference must be set to 简体中文.

Internationalization Settings of System Management

Log in to the decision-making system as the admin, choose System Management > Security Management > Security. Then enable Security Headers, click Advanced Setting, and enable Disable Browser Cache.

Click English in the upper right corner and select a language from the drop-down list to switch the language of the System Management page.

Internationalization Settings of the Login Page

After internationalization settings, you can switch the language through the drop-down list at the bottom of the login page, as shown in the following figure.

Note:

To use the language switchover function on the login page, the platform language preference must be set to 简体中文. For details, see section "Platform Language Preference."

After the login page language switchover function is enabled, the platform language follows the browser language of the login page and no longer follow the language that is set last time.