Add a new language localization to Absolute Service

Version 1

    Details

    PROBLEM
    A user installation may wish to have a new language added to LiveTime that doesn't exist today as one of the default languages.

    ENVIRONMENT
    LiveTime

    RESOLUTION
    1. Go to the webapps/Service/WEB-INF/Service.woa/Contents/Resources folder. This is under Server if installed using the installer or the application server location (eg TOMCAT_HOME) if installed the legacy manual way.

    2. In this folder, edit the HEATsoftwareLocales.xml file.

    3. For this example, we will enable Finnish. Find the lines that look like this:

            <!-- Finnish -->
            <!-- LOCALE language="fi" country="" charset="ISO-8859-1"/ -->

    Change these to this:

            <!-- Finnish -->
            <LOCALE language="fi" country="" charset="UTF-8"/>

    What we are doing here is activating the Finnish language and setting it to use the UTF-8 character set. Where possible the UTF-8 character set should be used as it provides greater compatibility with other languages.

    If the language in question doesn't exist in the properties file, a line can be created based on this template. The first line is a comment stating the language and the key part is the LOCALE language code. This is the code used in the HTTP_ACCEPT_LANGUAGE option in web communication and the corresponding code can be looked up on a page such as this one, where the third list shows the code:

    [url:]http://www.livio.net/main/charset.asp[/url:]

    4. Next we need a main properties file for Finnish language. This has to be saved in the encoding we set above. Since the English file is also UTF-8, the best solution here is to copy this file from HEATsoftware.properties to HEATsoftware_fi.properties. (This is just the one under the Resources folder. There is no need to copy any files under the Locales folder)

    5. Then we need to add an entry to the HEATsoftware.properties (English/default) and all the HEATsoftware_xy.properties like this:

    LocalizationManager.fi=Finnish

    To be 100% accurate, you'd have to find the translation for the language in question in the language of the file being edited.

    6. The content will be English throughout as the defaults for everything are based on the properties we replicated above so translating all the lines in that file is the next step. These values will then represent the default values for that language.

    7. Finally, restart LiveTime/Tomcat, and that's all that needs to be done. This needs to be done after any changes are made to the properties files directly.

    8. Any email templates can now be edited for Finnish, as can any customizations in LiveTime (Such edits create/update localized customization properties files under the /Service/Locales folder). Note that editing them here doesn't change the defaults. Such edits have to be done in the properties file under the Resources folder directly.

    To recap, to edit other fields and the default email templates, etc, should anyone reset things to defaults, the main HEATsoftware_fi.properties file under the Resources folder (mentioned at the start of this article) can be edited accordingly.

    ADDITIONAL INFORMATION
    None


    Resolution

    PROBLEM
    A user installation may wish to have a new language added to LiveTime that doesn't exist today as one of the default languages.

    ENVIRONMENT
    LiveTime

    RESOLUTION
    1.  Go to the webapps/Service/WEB-INF/Service.woa/Contents/Resources  folder. This is under Server if installed using the installer or the  application server location (eg TOMCAT_HOME) if installed the legacy  manual way.

    2. In this folder, edit the HEATsoftwareLocales.xml file.

    3. For this example, we will enable Finnish. Find the lines that look like this:

            <!-- Finnish -->
            <!-- LOCALE language="fi" country="" charset="ISO-8859-1"/ -->

    Change these to this:

            <!-- Finnish -->
            <LOCALE language="fi" country="" charset="UTF-8"/>

    What  we are doing here is activating the Finnish language and setting it to  use the UTF-8 character set. Where possible the UTF-8 character set  should be used as it provides greater compatibility with other  languages.

    If the language in question doesn't exist in the  properties file, a line can be created based on this template. The first  line is a comment stating the language and the key part is the LOCALE  language code. This is the code used in the HTTP_ACCEPT_LANGUAGE option  in web communication and the corresponding code can be looked up on a  page such as this one, where the third list shows the code:

    [url:]http://www.livio.net/main/charset.asp[/url:]

    4.  Next we need a main properties file for Finnish language. This has to  be saved in the encoding we set above. Since the English file is also  UTF-8, the best solution here is to copy this file from  HEATsoftware.properties to HEATsoftware_fi.properties. (This is just the  one under the Resources folder. There is no need to copy any files  under the Locales folder)

    5. Then we need to add an entry to the  HEATsoftware.properties (English/default) and all the  HEATsoftware_xy.properties like this:

    LocalizationManager.fi=Finnish

    To be 100% accurate, you'd have to find the translation for the language in question in the language of the file being edited.

    6.  The content will be English throughout as the defaults for everything  are based on the properties we replicated above so translating all the  lines in that file is the next step. These values will then represent  the default values for that language.

    7. Finally, restart  LiveTime/Tomcat, and that's all that needs to be done. This needs to be  done after any changes are made to the properties files directly.

    8.  Any email templates can now be edited for Finnish, as can any  customizations in LiveTime (Such edits create/update localized  customization properties files under the /Service/Locales folder). Note  that editing them here doesn't change the defaults. Such edits have to  be done in the properties file under the Resources folder directly.

    To  recap, to edit other fields and the default email templates, etc,  should anyone reset things to defaults, the main  HEATsoftware_fi.properties file under the Resources folder (mentioned at  the start of this article) can be edited accordingly.

    ADDITIONAL INFORMATION
    None