KB249512: How to Change or Remove the MicroStrategy Favicon Displayed in the Browser Using the MicroStrategy Web SDK 9.4.x-10.x

Starting with the release of Strategy ONE (March 2024), dossiers are also known as dashboards.
There is a small Strategy icon which appears next to the URL when viewing Strategy Web. This image is called a favicon, and is a browser feature which is associated with a particular website or web page.

Using the Strategy Java Web SDK 9.4.x, it is possible to change or remove this favicon.

 
1. Open the Web Customization Editor and create a new plugin.
2. Go to the Application Settings tab > Strategy Web Configuration > expand Pages.
3. Locate the page named '-1(Default Page)' and open in the editor.
4. Switch to the 'Template Properties' tab.

5. On the Default Tab, click on Modify next to the mstrWeb.aspx/jsp file reference to modify the template file. If prompted, agree to create a copy and edit the copy.
6. Comment out the lines in the files that call the favico.ico, as shown below to remove the favicon:

<!--  favicon -->
<!--<link rel="shortcut icon" href="../style/mstr/images/favicon.ico" type="image/x-icon" />-->
<!--  end favicon --> 

<!-- favicon -->
<link rel="shortcut icon" href="../plugins/customplugin/style/mstr/images/customfavicon.ico" type="image/x-icon" />
<!-- end favicon -->

7. Switch to the Processing tab of the Default Page and repeat steps 5-6 for the Wait.aspx/jsp file.

8. Locate the page named ‘error(Error Page)' and open it in the editor.
9. Switch to the Processing tab and repeat steps 5-6 for the aspx/jsp file.​
10. Next, minimize the WCE, and open the plugin using Windows Explorer. Navigate to /jsp folder and copy the following files your /plugins/customplugin/jsp folder:
         Empty.jsp
         Error_Content.jsp
 
For removing or changing the favicon when running a Report Services Document in Presentation Mode, see the following article:
​How to Change or Remove the MicroStrategy Favicon Displayed in the Browser When Running a Report Services Document in Presentation Mode using the MicroStrategy Web SDK 10.x
For the Html5Vi (HTML5 VI Page) (Dossiers) in Strategy Web 10.x, see the following article:
 
How to Change or Remove the MicroStrategy Favicon Displayed in the Browser for Dossiers using the MicroStrategy Web SDK 10.10
 
Note that when the image reference is removed, underlying favicon.ico images may be displayed in its place if another application specifies one.
 
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.
 
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 MicroStrategy Developer Zone .
 
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.
 
KB20171