Working With Message Bundles

Message bundles are used to customize the texts of the Cadenza UI. They are defined in .properties files - one file per language. The files must be co-located in the same directory and the language is included in the filename as a suffix, e.g. my-messages_de.properties for the German messages.

When setting the path to a message bundle as a system property or environment variable (see Setting a System Property or Environment Variable), the path must neither include the language suffix nor the .properties file extension.

Example:

If Cadenza is installed on a Windows system and there are my-messages_en.properties and my-messages_en.properties in the folder H:\CadenzaWebTheming\, the environment variable CADENZA_CUSTOM_PROPERTIES must be set to H:/CadenzaWebTheming/my-messages.

Different Languages

The only currently supported languages in Cadenza are German and English (_de and _en suffix respectively).

There’s no need to have .properties files for all languages. Overriding those that are relevant for your installation is enough.

Modifying Message Properties

A .properties file holds the messages to be used for its language as a set of <message-key>=<message> pairs.

Example:

If you set the CADENZA_CUSTOM_PROPERTIES (see Customizable Message Properties) to H:\CadenzaWebTheming\my-messages and you want to override the default productName to be Berichtssystem in German, you need to add the following line to your my-messages_de.properties file:

productName=Berichtssystem

If you do not override a message, the internal Cadenza default is used.

In general, the Java Properties mechanism is used (see the Oracle API docs on the Properties class).

The properties files are encoded in the UTF-8 encoding, so make sure your editor is also using this setting. This becomes relevant when entering non-ASCII characters such as ä for example.