KB39790: How to Remove the Help Link on the Export Options Page and Confirmation Page for Reports using the MicroStrategy Web SDK 9.2.1

The following customization will remove the help link on two pages (export options page and export confirmation page):
 
Export Options Page
Before Customization:

 
After Customization:

 
Export Confirmation Page
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.
 
Here are steps to remove the Help link on the export options page and export confirmation page:
 
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.

1. Launch the Web Customization Editor.
2. Create a new plug-in and give it a meaningful name. For example: removeHelpLinkOnExportPage. (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 Settings > Creating a New Plug-in in the MSDZ).
3. On the Applications Settings tab, navigate to Strategy Web Configuration > Pages
4. Double-click on the SaveReportProperties page, the export Properties window should open.
5. Go to the Template Properties tab
6. The Default tab should be open under Page Templates
7. Right-click on header - /jsp/Export_Options_Header.jsp or asp/Export_Options_Header.aspx and click on the "Edit current file"
8. Click Yes if a pop up appears ("Editing this file will create a copy in your plug-in folder and this copied file will be opened for editing. Do you want to continue?")
9. Search for
    
   
   Sample Code/Error
   <%@include file='/jsp/eTrainer_Section.jsp' %>
   
    
   and delete the line directly after that:
    
    
   
   Sample Code/Error
   <web:resource type="helpUser" name="Exporting_to_CSV_file_format.htm"/>
   
    
    
   
10. Repeat steps 4-9 for the exportOptionsFromReport page to remove the help link on the Export Options Page.
11. Save changes.
12. Restart the Web Server.

 
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.