KB42491: How to Create a Toolbar Button that will Export a Specific Document Using the MicroStrategy Web SDK 9.4.1

This example will show how developers can create a toolbar button that will export a specific Strategy document. This would be useful for those who want to make a particular document accessible to their users at all times.
 
STEPS TO REPRODUCE:
 

• In the Web Customization Editor, go to Pages > Expand the Report page > Beans > frame > right click the "rb" and select "New Event Handler"
• After specifying the source and package, enter a unique EventID and Event name. This number should not be a number that already exists so choose a high number like 50000.
• Go ahead and click Next and finish to create the Event Handler. Two files will open, the Enumeration class and the Event Handler class.Keep them both open for now.
• Open the Event Handler class and add the following code to the processRequest method:

 public boolean processRequest(RequestKeys keys) throws WebException {
        WebEvent event = getWebEvent(keys);
        if(event == null) {
            return super.handleDefaultRequest(keys);
        }
        
        System.out.println(event.getID());
        switch(event.getID()) {
            case Enumexportdocumentfromreport2Events.BEAN_EVENT_EXPORTDOCUMENTFROMREPORT2 :
             System.out.println("custom event was hit");
             
              WebEvent webEvent = getWebComponent().getRoot().getWebEvent(3069);
             //WebEvent webEvent = null;
              if (webEvent != null) {
          
                     webEvent.setArgumentValue(EnumServletEvents.WebEventArgumentObjectID
, "FD19021F4E19112821C9C18145F118B7");
                
                     ParameterBuilder pb = new DefaultURIBuilderImpl();
                     pb.addEventInfo(
                       webEvent,
                       EnumEventElement.EventElementTypicalURLLink,
                       EnumWebPersistableState.MINIMAL_STATE_INFO
                       );
                     
                     getWebComponent().getRoot().handleRequest(new StringRequestKeys(pb.toString() , true));      
              }
              
                return true;
            default :
                return super.handleDefaultRequest(keys);
        }
    }

 

•  This logic can be added to a toolbar by creating a new toolbar element for that toolbar and selecting the option "An event within Strategy Web" for the action to be triggered when clicking on the toolbar element.
• On the next screen, the event enumeration class will need to be specified. Type the name of the enumeration class that was created with the event handler.
• Save and restart the web server for the settings to take place.

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 Strategy Developer Zone (https://resource.microstrategy.com/msdz/).
 
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 http://www.microstrategy.com/Support/ContactUs.asp.
 
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.