KB39701: How to Modify Error Messages During Report Execution Using the MicroStrategy Web SDK

Before Customization:

After Customization:

The example provided in this document is provided “as-is” to the user and assumes that the user:

• Can program, compile (e.g. javac, jikes, etc.), and execute Java programs
• Can configure environment variables (e.g. JAR files, property files, etc.)
• Have all the necessary tools to create Java applications (JDK, IDE, etc.)
• Has access to the Strategy SDK documentation.
• Has read the customization warning at the bottom of this document

PREREQUISITES:
 
For the sample to work, the Strategy Web JAR files must be accessible by the Java Runtime
Environment. The Strategy Web JAR files can be found under:

• Strategy Web Universal (JSP): {web_root}/WEB-INF/lib directory.
• Strategy Web (.NET): Program Files\Common Files\Strategy directory.

Note:
 
More elaborate programs will require additional library files and are out of the scope of this document.
 
Using the Web Customization Editor to create a plug-in
 
Strategy SDK provides a Web Customization Editor that can be used to create a customization plug-in. The following steps show how to create the plug-in and deploy.
 
Below are the steps to perform this customization.  For ease, this customization is carried out in 3 parts:

 
All parts can be placed in the same plugin or multiple plugins – it is to the developer’s discretion.
 
Part I – Removing the error message (all error messages).

• Launch the Web Customization Editor. 
• Create a new plug-in and give it a meaningful name. For example: RemovingErrorMessage. (For step by step instructions on creating a new plug-in, please navigate to Home > Web SDK > Customizing Strategy Web > Web Customization Editor > Features and Customizable)
• On the CSS Settings tab, navigate to CSS > Strategy Web Styles > style > mstr > images > fsm.css
• Look for the following selector .mstrAlertMessage
  

• Right click on .mstrAlertMessage > New Property.  Set the following values for the new CSS Property and value – Property: display Value: none !important
   

• Click OK.
• Restart Web to see the changes take effect (you can restart after ALL 3 parts are finished to see all the changes at one time).

Part II – Removing the “Show Report Details” button that will display the same SQL error (if there is one).

1. For this customization, there is already documentation on our knowledge base.  Please follow TN 38669 for step by step instructions on removing this button.

Part III – Modifying the “Error in Report Results” message

• Launch the Web Customization Editor. 
• Create a new plug-in and give it a meaningful name. For example: ModifyingErrorTitle. (For step by step instructions on creating a new plug-in, please navigate to Home > Web SDK > Customizing Strategy Web > Web Customization Editor > Features and Customizable)
• Click in Strategy Web Configuration inside the Application Settings view to expand the hierarchical tree. The expanded list comprises the different settings that can be modified to perform customizations. 
• Navigate to Property Files > WEB-INF > classes > resources
• Double-click on “MessagesBundle_en_US.properties” to open the editor.
  

• Filter for “Error in report results”
  

• Highlight the Value “Error in report results” and change it to the message you wish.  In this example, the error message was changed to “This report is not available at this time.  Please contact your administrator.”
  

• Save your changes.
• Restart the Web Server to see the change in Web.

  
ADDITIONAL INFORMATION:
 
The Strategy SDK allows you to customize the standard Strategy Web interface, and extend and integrate the Strategy business intelligence functionality into other applications. However, before changing the way Strategy Web products look or behave, it is helpful to understand how the application is built. For more information regarding the Strategy Web architecture or the process of customizing Strategy Web, please refer to Strategy Developer Zone (https://community.strategy.com/topic/0TO44000000FliLGAS/sdk).
 
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@microstrategy.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.microstrategy.com/en/support/contact-support.
 
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.