KB47620: How to Add a Custom Help to MicroStrategy Web Using MicroStrategy Web SDK 9.4.1

SYMPTOM:
Sometimes users want to see a link to a custom help in Strategy Web as shown in the screenshot below. To add this link, follow the steps provided in this technical note.                                

ACTION:
 

1. In your Strategy Web folder, navigate to plugins -> _Interface -> jsp and make a copy of the file "Generic_Path.jsp) 
2. Launch MicroStrategy Customization Editor .
3. Create a new plug-in and give it a meaningful name.
4. Place the copy of Generic_Path.jsp inside your plugin. Make sure it is inside the jsp folder, '..plugins/<pluginName>/jsp'
5. Look for these lines of code inside Generic_Path.jsp.
   

   
   <%-- Render a hyperlink to the Online Help. --%>
   
   <span class="mstrShortcut"><web:resource type="helpUser"/></span>

   
   
6.  Add the following code below the code from step 5
   

   
   <td width="10%">
   <a <web:value type="custom" attribute="href" name="AddingLinkCustomHelp/help/WebUser/WebHelp/Lang_1033/Add_prompts_to_reports.htm"/> target="_new"><web:descriptor key="" desc="Custom Help"/></a>
   </td>
   

   
   
7. Select the Application Settings tab.
8. Expand the pages folder.
9. Double click shared (Shared Report) page.
10. Select the Template Properties tab as shown in the image below:​

1. Right click path and select "Choose a new file"
2. Select the Generic_Path.jsp file that you copied inside your plugin
3. Save the changes and restart your web server

 
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 MicroStrategy Developer Hub.
To access the Strategy Developer Hub, 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 Hub, 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/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.