AnyLogic
Expand
Font size

Private Cloud: Custom Localization

Starting from version 2.2.9, Cloud supports built-in Russian and Chinese localization packages.

In addition, you can configure your Private Cloud instance to use a custom localization package. You can localize the bulk of the Private Cloud UI, including general items of the interface, configuration screens, administrator panel, and so on.

The localization is supported with Transloco — an Angular internationalization library.

Prerequisites

To start, you need a package containing JSON files that will be used by the instance to replace the strings in UI. To obtain the package, request it from our support team at support@anylogic.com.

The package includes the following files:

  • xx.json — contains most of the strings visible by guests and regular users, including settings of dashboards and user profiles.
  • admin/xx.json — contains strings that are shown in the administrator panel.
  • model/xx.json — contains strings that are shown on the model screen and its tabs.

Edit these files to create your localization package.

Configuring the instance

  1. Start by picking a valid language code from the Unicode Languages and Scripts list.
    • Do not use codes of languages already available in your Private Cloud shipment.
    • Using a code from this list is the hard requirement for the Transloco library; you, however, don’t have to follow its conditions and just pick any vacant code for your needs.
  2. Rename files in the localization package using the language code you have chosen. For example, for a French localization package, file names should look like this:
    fr.json
    admin/fr.json
    model/fr.json
  3. To configure the controller component and make it aware of the new localization, edit the i18n.json file, located in the /alc/controller/conf directory in your Private Cloud installation. Add a code of your language (for example, "fr") to the list of languages. Make sure the resulting file is a valid JSON file. Optionally, you can set the instance to use your new localization by default. To do that, set a new value for the "defaultValue" JSON field.
  4. Go to the /alc/controller/preload/frontend/assets/i18n/ directory in your Private Cloud installation.
  5. Place your localization package in the directory, preserving its structure. The primary file (in our example, fr.json) should end up in the i18n directory, and auxiliary files will be located in i18n/admin/fr.json and i18n/model/fr.json, respectively.
  6. In the Linux terminal on the machine that serves the controller and frontend components, execute the following command:
    sudo docker restart controller && sudo docker stop frontend

After a little while, the necessary components will restart and the localization package will be applied. You will then be able to use Private Cloud translated to your preferred language.

To switch between available languages, use the drop-down picker on the main toolbar.

How can we improve this article?