Localization Process - EcoSys - Administration & Configuration - Hexagon

EcoSys System Administration

Language
English
Product
EcoSys
Search by Category
Administration & Configuration
EcoSys Version
9.1

If additional non en-us locales are required on an EcoSys environment, the following process can be used to add additional locales.

  1. In a dev/test environment, enable the locale maintenance process.

    This process creates key-value pair files on disk for each configuration item in EcoSys for the en-us locale. This is required to maintain the en-us and any additional locales for each string that can appear in the UI.

    The process runs in intervals and will re-process any configuration that has been modified like changing a title/caption/parameter caption in that interval to keep the en-us locale files current.

    It is recommended to perform localization in dev/test environement and to migrate the locale files with the configuration to production.

    1. Turn on the localization process maintenance process using the server setting below. The best practice is to enable the process using one node in Cluster.

      server.locale.maintenance.enabled (false by default)

    2. Determine how often you wish to run the localization process. The server setting is as follows:

      server.locale.maintenance.intervalMinutes (15 by default)

      Once enabled, EcoSys creates directories for each configuration element in the ESFM_HOME\locales folder and for each configuration type, an en-us file directory is created.

      A <configuration_ ID>.properties file is created for each configuration item. The file contains key-value pair for all strings that appear for the configuration item on screen

  2. Once the maintenance process is enabled, monitor the process and ensure that all locale keys are written to disk.

    1. Navigate to Application Settings > Locales tab.

      When you initially load the page, you will be prompted to click Refresh to load the locale data.

    2. Click Refresh.

      The page displays the current state of the locales.

      As the maintenance thread runs, a new en-us column is added at the bottom panel which displays the count of how many items have been processed.

      On a clustered EcoSys environment, cluster sync messages are sent by the node running the maintenance process to all other nodes in the environment so that en-us locale files are created on all nodes. It is important that all nodes are running when performing localization.

      The table will have an en-us column for each node in the cluster.

  3. Ensure that the number of items in the Total column and en-us column match for all nodes in the cluster. If the count does not match, review the Display log messages for more information.

    Some common reasons why the locale process cannot process a configuration are:

    • Invalid Configuration - The failed configuration is mis-configured, missing a required setting or some other problem that does not allow EcoSys to fully load it. To determine the problem, preview the configuration in the associated dictionary and resolve the problem.

    • Empty Configuration – Errors might also be logged when a menu has no menu items, screen layout has no panels assigned, spreadsheets/forms/actions/charts/reports have no columns and so on.

  4. Click EXPORT to export a consolidate en-us.properties file that contains all static and configuration strings.

  5. Translate the file into the required new locale.

    The new file name must be a valid java locale with the .properties extension. For example, es-es.properties for Spanish Spain.

    EcoSys recommends using Phrase.com as a tool to perform and manage the translation process. Refer to Translating the Locale file.

  6. Click IMPORT and select the file to import it into EcoSys.

    This creates new locale files on the current node and sends cluster synch messages to all other nodes in the cluster.

    1. To determine that the synchronization of the new locale to all cluster nodes is completed, click REFRESH in the UI and new locales will be added to the table for the new locale per cluster node.

    2. Continue to refresh the UI until all nodes have the new locale with the number of keys matching.

  7. Once the numbers match, on the Locale tab, click the REINITIALIZE button.

    After reinitializing EcoSys, the locale will be available on all nodes on the cluster.

    Using the RESET button, you can regenerate the en-us file. This will reset localization to a clean ‘out-of-the-box’ state and remove any non en-us locales. Once you restart, you must restart the localization process from the beginning.