Language Resources

Owned by Kyle McEwan
Last updated: Sept 11, 2023
2 min read

NOTE: Not all areas of CSUM currently allow the use of several language resources.

CSUM comes shipped with 2 initial language translation files, One for the English language and another for German. However, it is now possible to add your own translation files for whatever languages you please.

How to change the language resource used for your profile

The language used for CSUM is user/profile independant and is defined in your Profile settings found at:

  • Profile > Settings > Language

However, if you attempt to use a language that doesn’t have a resource file within your application JAR, then you will not be able to use CSUM in that language.

How to add your own language translations file

As new versions of CSUM are released, these translation keys may change and translation modifications are out of our support scope and therefore it is your responsibility to keep your custom translation files up to date and working.

Dont forget to add your custom translation property files to the CSUM jar every time you upgrade as it will not remain present when you upgrade due to the JAR being replaced, so store somewhere safe other than just the CSUM JAR!

  1. Find the csum_resources.properties file within the CSUM JAR, found at:

    • /csum/confluence/permissionmgmt/react_i18ns/

  2. Add the Locale of the new language that you will be adding a translations file for, followed by the name of the properties file that will be added containing the translations. Below are a few of the existing examples such as “en_GB” which is the English, Great Britain Locale and “csum_en_GB“ is the properties file that will contain the English translations.

https://www.oracle.com/java/technologies/javase/jdk8-jre8-suported-locales.html

en_GB=csum_en_GB de_DE=csum_de_DE

  1. Then create the new properties file which will contain all of the translations within the folder that you found the csum_resources.properties file at, /csum/confluence/permissionmgmt/react_i18ns/. It MUST have the same name as you defined in the csum_resources.properties file, i.e. csum_en_GB.properties

  2. Within this file is where you add your translations, you MUST include all keys and their translations or CSUM wont be able to find what text to display within the UI and it will appear broken. Below are a few examples:

    1. English

csum.configuration.title=CSUM Configuration

b. German

csum.configuration.title=CSUM-Konfiguration

  1. The csum_en_GB.properties file that is shipped with CSUM contains all keys that are used within CSUM, you must translate all of these keys if youd like your new translation file to work.