KB42055: How to Prevent a Single Document from going to History List using the MicroStrategy Web SDK 9.3.0

Strategy Web 9.3.0 allows administrative users to control whether reports/documents are automatically sent to history list:
 

However, if needed, an add-on can be created to prevent a single document from going to History List when their Web preference is set to automatic for 'Add reports and documents to History List".  Step-by-step instructions are to follow.
 
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.
 
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.
 

• Launch the Web Customization Editor.
   
  
• Create a new plug-in and give it a meaningful name. For example: PreventHistoryListAddOn. (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).
   
  
• Click in 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.
   
  
• Navigate to Pages. Right-mouse click rwd(Report Writing Documents) and select Create New Add-On to launch the New Add-On Class Wizard.
   
  
• Click Browse... next to the Source folder’s text field to select the src folder and click OK.
   
  
• Enter the following information for the rest of the text fields:
  Package: ##Any package the client wants to use##
  Name: PreventDocHistoryList_AddOn
  Add-on description: This add-on will prevent a single document from going to the history list.
  Check the box for “Add custom logic before fetching data from Intelligence Server (preCollectData)"
   
  

• Click Finish. The PreventDocHistoryList_AddOn.java file should open in Eclipse. For additional information on Add-On creation, reference the MSDZ (Home > Web SDK > Customizing Strategy Web > Part II: Advanced Customization Topics > Customizing Add-ons> Add-on Creation).
   
  
• Modify the preCollectData method as follows:
   
   
  
  Sample Code/Error
  
      private final String doc_id = "5FD5318C4EF42171BE36E7BCD4A150C9";
     
      public void preCollectData(PageComponent page) {
       try{
        RWBean rwb = getRWBean(page);
        if(rwb == null){
         return;
        }
        
        String id = page.getAppContext().getRequestKeys().getValue("documentID");
        if(!doc_id.equals(id)){
         rwb.setSaveToInbox(rwb.isFeatureAvailable(EnumAppWebFeatures.WebFeatureAutoAddHistoryList));
        }
        else{
         rwb.setSaveToInbox(false);
        }
       }
       catch(Exception e){
        e.printStackTrace();
       }    
      }
       
      private static RWBean getRWBean(WebComponent wc) {
       RWBean result = null;
     
       //if the current web component is a ReportBean then return it
       if (wc instanceof RWBean) {
        result = (RWBean) wc;
        //otherwise, try to find a report bean amongst the page children
       } else {
        for (int i = 0; i < wc.getChildCount(); i++) {
         //search recursively through all children
         result = getRWBean(wc.getChild(i));
         if (result != null) break;
        }
       }
       
       return result;
      }
  
  
   
  
• Save the changes.
  
• Double-click rwd(Report Writing Documents) to open the editor.
   
  
• Click on the Add-on Properties tab. On the Add-On Properties tab, the custom add-on class PreventDocHistoryList_AddOn, should be listed under Class Name:
   
  

• Restart the Web Server to see the changes applied in Web.

 
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.