Localizing Messages

Workflow rule services can return text messages and other content to be displayed in the view. Unlike the data stored in the database, messages typically need to be localized. The reason for this is that users from different regions, countries, and time zones can connect to the same Web Central server.

Web Central knows the language and region preferences for any connected user, and it exposes methods that translate text messages to the current user locale. There are two options for storing and accessing translated messages.

Loading translatable messages from the lang files

The localizeString() method translates specified text by loading the locale-specific translated text from the corresponding -xx.lang file stored in the schema\ab-system\lang folder.

// @translatable
String message = localizeString(context, "Form data was successfully saved")


If the translatable message does not exist in the lang file, the method returns the original (not translated) message.

If you introduce the new translatable message that does not yet exist in the lang file, we recommend placing the @translatable comment directly before the call to the localizeString() method. This comment marks the location of the translatable message for the localization team that uses Archibus Localization Kit.

This method is recommended to translate general-use messages that are already translated and stored in the lang files.

Loading translatable messages from the messages table

The localizeMessage() method loads the translated message from the messages database table:

String message = localizeMessage(context,
"AbWorkplaceReservations",
"AddRoomReservation_WFR",
"TimePeriodNotAvailable",
null);

The translated message is identified by:

  • the ID of the application that the WFR belongs to
  • the ID of the Web Central object that references the translatable message
  • the unique message ID.


This method is recommended to translate application-specific messages. Since the translated messages are stored in the database table, the application installers and site administrators can use Web Central UI to modify the text of translated messages.