Multi-language configuration

SuperMap iPortal and built-in WebApps both support multi-language environment. By default, Chinese and English bilingual configurations are provided. If the default languages cannot meet the usage environment, you can customize the portal site in a specific language according to your region and language habits.

• Customize a new language for iPortal
• Supported languages

Customize a new language for iPortal

The process is as follows:

1. Write new language files

Step 1: Create a new language configuration file under %SuperMap iPortal_HOME%\webapps\iportal\resources\web-ui\config path, for example Language_ja.json. The file name followed by "Language_" must follow the corresponding "Filename" in the internationalization table of languages supported by iPortal. After the creation, fill in the file contents, the structure of which must be consistent with the corresponding Language_zh.json/Language_en.json file.

Step 2: Create a new language configuration file under %SuperMap iPortal_HOME%\webapps\iportal\resources\admin-ui\lang path, for example Language_ja.json. The file name followed by "Language_" must follow the corresponding "Filename" in the internationalization table of languages supported by iPortal. After the creation, fill in the file contents, the structure of which must be consistent with the corresponding Language_zh.json/Language_en.json file.

Step 3: Create a new language configuration file under the path %SuperMap iPortal_HOME%\webapps\iportal\resources\web-ui\config\locales\homePage, for example ja.json. The file name must follow the corresponding "Filename" in the internationalization table of languages supported by iPortal. After the creation, fill in the file contents, the structure of which must be consistent with the corresponding zh.json/en.json file.

Step 4: Enter %SuperMap iPortal_HOME%\webapps\iportal\WEB-INF\lib, create and add new language configuration files for each WebApps. The file name must follow the corresponding "Filename" in the internationalization table of languages supported by iPortal, for example, ja.json. The structure of file contents must be consistent with the corresponding zh.json/en.json file. And the files should be added to the paths shown as follows under the corresponding DataViz/DataInsights/MapDashboard jar package.

• For DataViz: %DataViz_HOME%\META-INF\resources\apps\dataviz\static\nls
• For DataInsights: %DataInsights_HOME%\META-INF\resources\apps\insights\language
• For MapDashboard: %MapDashboard_HOME%\META-INF\resources\apps\mapdashboard\v2\static\locale

Step 5: Enter %SuperMap iPortal_HOME%\webapps\iportal\WEB-INF\lib, create and add a new language configuration file to the META-INF\resources\admin-ui\locale\setup path of the iportal-adminui-{version.number}.jar package, for example, ja.json. The file name must follow the corresponding "Filename" in the internationalization table of languages supported by iPortal. And the structure of file contents must be consistent with the corresponding zh.json/en.json file.

2. Import the new language files into iPortal

Step 1: Open the locales.json configuration file under the path %SuperMap iPortal_HOME%\webapps\iportal\resources\web-ui\config\locales\, the file structure is as follows:

{

    "locales": [

        {

            "name": "zh",

            "label": "中文"

        },

        {

            "name": "en",

            "label": "English"

        }

    ],

    "default": "en"

}

Add a new item to the locales item, where the value of the key "name" needs to be consistent with the name followed by the language configuration file name "Language_" created in previous steps, the value of the key "label" can be customized to indicate the language name displayed on the page. Taking Japanese as an example, the modified configuration file is as follows:

{

    "locales": [

        {

            "name": "zh",

            "label": "中文"

        },

        {

            "name": "en",

            "label": "English"

        },

        {

            "name": "ja",

            "label": "日本語"

        }

    ],

    "default": "en"

}

Step 2 (optional): Modify the default language. The parameter "default" in the locales.json file is used to specify the default display language of iPortal. Note: The "default" setting will only take effect when iPortal does not support the default language set in the user's browser. The priority of the iPortal default language display rules is: Browser Cookie>Browser default language>default value.

Step 3: Save the configuration file.

3. Modify the language of the iPortal home page

Step 1: Log in to iPortal with your administrator account, navigate to Management > Site Configuration > Site customization page, click the "Home customize" link to enter the home page customization page.

Step 2: In the layout builder, modify the title and description text of each component on the homepage and save it.

Step 3: Restart iPortal. The bottom of the home page provides a drop-down box for multiple languages. Select the new language, then you can visit the new language iPortal site.

Note: Multi-language configuration does not take effect on the language of log files and prompt messages. You can modify the [SuperMap iPortal_HOME]\bin\catalina.bat(.sh) file to specify the display language of iPortal log files and prompt messages. For details, please refer to: FAQ.

Supported languages

iPortal currently supports 62 languages for customization. For details, please refer to the following internationalization comparison table: