KB309904: Using Localized MessagesBundle Strings with the MicroStrategy 10.5 Web SDK

Summary
Strategy Web uses localized descriptor files to provide multiple translations for the same strings. In Strategy Web, the localized descriptor files are the MessagesBundle files found in the WEB-INF/classes directory of Strategy Web. 
For more information on Strategy Web & localization, refer to the following developer zone article:

• Using Localization Descriptor Files
  

The majority of localized messagesBundle string uses resolve around customizing existing strings. This article covers how to programmatically use localized strings from the messagesBundle files, using the Strategy Java API, for example within an addon, transform, or custom event handler.
 
Adding new strings
New strings can be added to existing messagesBundle files, per the following documentation:

• Adding a New String to the Localization Descriptor File

 
Accessing messagesBundle strings in Java
Messages are exposed through the AppContext object, and can be accessed through the getMessages() call:

appContext.getMessages().getString("mstrWeb.xxx");

 
API Reference on Messages:
https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/web/beans/Messages.html
 
Getting the appContext from a bean
Most addon and transform implementations expose reference to beans in the Web API. One common bean used in many scenarios is the ReportBean, tied to report execution. Other beans should expose the same methods.
If the ReportBean is in the object rb, the following can be used to access the appContext tied to that ReportBean instance:

AppContext appContext = (AppContext) rb.getRoot().getBeanContext();

 
The appContext can then be used to access the Messages to get the localized descriptor for a key.
 
Getting the appContext in an event handler
A custom event handler should automatically expose the getWebComponent method. This can be used to access the AppContext:

AppContext appContext = (AppContext)getWebComponent().getBeanContext();

 
The example provided in this document is provided “as-is” and user has read the following customization warning:
​
ADDITIONAL INFORMATION:
The Strategy SDK allows you to customize several Strategy products and extend and integrate the Strategy business intelligence functionality into other applications. However, before changing the way Strategy products look or behave, it is helpful to understand how the application is built. For more information regarding the Strategy products or the process of customizing Strategy products, please refer to Strategy Developer Zone (https://developer.Strategy.com).
To access the Strategy Developer Zone, you must have access to the Strategy Knowledge Base, you must have purchased the Strategy SDK, and you must be current on your Strategy maintenance agreement. If you are a US-based business and believe that you satisfy all three of these conditions but you do not have access to the Strategy Developer Zone, please contact Strategy Technical Support at support@Strategy.com or at (703) 848-8700. If you are an international business, please contact Strategy Technical Support at the appropriate email address or phone number found at https://www.Strategy.com/us/services/support/contact.
CUSTOMIZATION WARNING:
This customization is provided as a convenience to Strategy users and is only directly applicable to the version stated. While this code may apply to other releases directly, Strategy Technical Support makes no guarantees that the code provided will apply to any future or previous builds. In the event of a code change in future builds, Strategy Technical Support makes no guarantee that an updated version of this particular customization will be provided. In the event of a code change in future builds, Strategy may not be able to provide additional code on this matter even though this customization is provided at this time for this specific build. For enhancements to this customization or to incorporate similar functionality into other versions, contact your Account Executive to inquire about Strategy Consulting assistance.