KB236508: Custom Toolbar Element Triggering the WebEventLogout Event Does Not Work for Report Services Documents With MicroStrategy 9.4.1 Web SDK

SYMPTOM:
A custom toolbar element is added to the "rwd(Report Writing Documents)" page. The element action is set to trigger "An event within Strategy Web", with the type of listener method set to "onselectionchange".  For the "Event Enumeration class", com.Strategy.web.app.beans.EnumServletEvents is selected.  "WebEventLogout" is selected as the event to trigger when the toolbar element is selected.  These changes do not create a custom toolbar that allows the user to log out.
 
STEPS TO REPRODUCE:

1. Click on 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.
2. Click on Pages to expand the list of pages used in Strategy Web. Right-click the rwd(Report Writing Documents) page and select Toolbars->Add Custom Toolbar Elements.
3. Choose "DocumentHomeToolbarModel" and click on "Next".
4. For "Select the type of action to be triggered when clicking this toolbar element", choose "An event within Strategy Web". Fill in the rest of the page as necessary and click "Next".
5. For "Event enumeration class", choose EnumServletEvents. Select the event "webeventlogout" to allow users to log out.
6. Click Next until it finishes.
7. Restart the web server to check the effect.

 
Selecting this custom toolbar element in a document has no effect. The JavaScript console in the browser returns the following error when the button is clicked:

Uncaught TypeError: undefined is not a function

 
Note: this custom toolbar element definition may be observed as functional with reports when added to the "report(Report Execution)" page.
 
CAUSE:
This is a known issue in Strategy Web 9.4.1. 
 
ACTION:
Contact Strategy Technical Support for an update of the latest status on this issue.
 
WORKAROUND:
An out-of-the-box event can be used to trigger the logout action.
Instead of selecting "An event within Strategy Web" as the trigger, select "A hyperlink to a different page". For the hyperlink, use the following for a JSP deployment:

?evt=3008&src=mstrWeb.3008

 
 Or the following for an APS.NET deployment:

?evt=3008&src=Main.aspx.3008

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 Strategy Developer Zone (https://developer.Strategy.com).
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@Strategy.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.Strategy.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.