MicroStrategy ONE

Customizing Error Messages

This scenario deals with adding your own error messages so they are displayed in the MicroStrategy Web products. All the error messages (and other text displayed) are saved in MessagesBundle files. This task involves modifying an existing error message by editing the appropriate text in the MessagesBundle files.

Before you perform this customization, when users attempt to access an object to which they do not have access, they see the following out-of-the-box message:

You do not have sufficient permission to access the resource you requested. If the problem persists, please contact the MicroStrategy Server Administrator.

After you perform this customization, when users attempt to access an object to which they do not have access, they see the following new custom message:

Please contact your System Administrator by sending an e-mail to sysadmin@xyz.com.

This customization can be accomplished using either of the following methods:

Deploying the plug-in provided with MicroStrategy SDK

MicroStrategy SDK provides a plug-in (ZIP file) that can simply be extracted to thepluginsfolder to view the customization in MicroStrategy Web. The following steps guide you in locating the plug-in and deploying it. 

  1. Access the plug-in: JSP version or ASP .NET version. 

  2. Extract the plug-in to the plugins subfolder inside the MicroStrategy Web installation folder.   

  3. Launch MicroStrategy Web to view the customization.

Using the Web Customization Editor to create a plug-in

MicroStrategy SDK provides a Web Customization Editor that can be used to create a customization plug-in. The following steps guide you in creating the plug-in and deploying it. 

  1. Launch the Web Customization Editor. 

  2. Click on MicroStrategy 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. 

  3. Enable the Property Files setting from the Show Advanced Options in MicroStrategy Preferences. 

  4. Navigate to WEB-INF->classes->resources and double-click on MessagesBundle_en_US.properties to launch the Web Properties Editor. 

  5. Enter a new property-value pair in the text field at the bottom confirming to the syntax nameOfProperty=value. For example: scenario1.4=Please contact your System Administrator by sending an e-mail at sysadmin@xyz.com. 

  6. Click Add. 

  7. Save your changes. 

  8. Collapse Property Files and click on Error Lists in the tree. 

  9. Double-click the Errors node. 

  10. Click on error ID -2147214570 in the list. 

  11. Click on the text (first row) under the Description header in the Messages section and replace the existing message with Please contact your System Administrator by sending an e-mail at sysadmin@xyz.com. 

  12. Click on the text (first row) under the DescriptionID header and replace the existing entry with scenario1.4. 

  13. Save your changes. 

  14. Launch MicroStrategy Web to view the customization.

See Also