KB17117: How to clear the filter expression of a report using the MicroStrategy Java Web SDK

In Strategy Web 9.x, it is possible edit a report and delete its filter expression. It is also possible to perform this same action using the Strategy Java Web SDK. To achieve this, perform the following steps:
 

1. Retrieve and execute the report from the Strategy Intelligence Server 9.x:
    
   

   
   WebBeanFactory bfactory = WebBeanFactory.getInstance();
   reportBean = (reportBean) bfactory.newBean("ReportBean");   
   reportBean.setSessionInfo(serverSession);
   
   reportBean.setResultFlags(reportBean.getResultFlags()|  EnumDSSXMLResultFlags.DssXmlResultFilter|
   EnumDSSXMLResultFlags.DssXmlResultGrid |
   EnumDSSXMLResultFlags.DssXmlResultViewReport |EnumDSSXMLResultFlags.DssXmlResultWorkingSet );
   
   reportBean.setName("FilterReport");
      
   reportBean.setObjectID("D938B9AF4E32A0C309FEC9927EC1C751"); 
   //get parent folder for later:
   WebFolder ofolder = (WebFolder)reportBean.getObjectInfo().getParent();
   //get the report name
   String reportName = reportBean.getObjectName();
   WebReportInstance ri = reportBean.getReportInstance();
   ri.setAsync(false);
   

   
    
   
2. Retrieve the filter information from the report working set and clear the current expression:
   ri.getWorkingSet().getFilter().getExpression().clear();
   
3. Since the report's definition has been modified, it will be necessary to call the Report Manipulator object and apply the changes. Doing this will send any template or filter changes back to the Strategy Intelligence Server 9.x.
   WebReportInstance ni = ri.getReportManipulator().applyChanges();
   
4. Finally, save the report. This call will automatically overwrite the original report with the new one
    
   

   
   int status = ni.pollStatus();
   ni.setSaveAsFlags(EnumDSSXMLReportSaveAsFlags.DssXmlReportSaveAsOverWrite);
   WebObjectInfo newInfo = ni.saveAs(ofolder,reportName);
   

   
    
   

Below is the code in its entirety:
 
 

import com.Strategy.web.beans.ReportBean;
import com.Strategy.web.beans.WebBeanFactory;
import com.Strategy.web.objects.WebFolder;
import com.Strategy.web.objects.WebIServerSession;
import com.Strategy.web.objects.WebObjectInfo;
import com.Strategy.web.objects.WebObjectsFactory;
import com.Strategy.web.objects.WebReportInstance;
import com.Strategy.webapi.EnumDSSXMLApplicationType;
import com.Strategy.webapi.EnumDSSXMLReportSaveAsFlags;
import com.Strategy.webapi.EnumDSSXMLResultFlags;

public class GetFilterFromReportBean {
 
 public static void main(String[] args) { 
  String SessionID = "";
//  Create factory object.

   WebObjectsFactory factory=WebObjectsFactory.getInstance();
   WebIServerSession serverSession=factory.getIServerSession();    
     
   ReportBean reportBean;
   
   serverSession.setServerName("ISERVERNAME");
   serverSession.setServerPort(0);
   serverSession.setProjectName("PROJECTNAME");
   serverSession.setLogin("USER");
   serverSession.setPassword("PASSWORD");
   serverSession.setApplicationType(EnumDSSXMLApplicationType.DssXmlApplicationCustomApp);    

   try { 
   SessionID = serverSession.getSessionID();
   System.out.println("Welcome " + serverSession.getLogin());
   WebBeanFactory bfactory = WebBeanFactory.getInstance();
   reportBean = (reportBean) bfactory.newBean("ReportBean");   
   reportBean.setSessionInfo(serverSession);    
  
   reportBean.setResultFlags(reportBean.getResultFlags() | 
  EnumDSSXMLResultFlags.DssXmlResultFilter|
EnumDSSXMLResultFlags.DssXmlResultGrid |
EnumDSSXMLResultFlags.DssXmlResultViewReport|
EnumDSSXMLResultFlags.DssXmlResultWorkingSet );
   reportBean.setName("FilterReport");
   
   reportBean.setObjectID("D938B9AF4E32A0C309FEC9927EC1C751"); 
   
   //get parent folder for later:
   WebFolder ofolder = (WebFolder)reportBean.getObjectInfo().getParent();
   //get the report name
   String reportName = reportBean.getObjectName();
   
   WebReportInstance ri = reportBean.getReportInstance();   
   ri.setAsync(false);    
   
   ri.getWorkingSet().getFilter().getExpression().clear();
 
 WebReportInstance ni = ri.getReportManipulator().applyChanges();
 int status = ni.pollStatus();
 ni.setSaveAsFlags(EnumDSSXMLReportSaveAsFlags.DssXmlReportSaveAsOverWrite);
 WebObjectInfo newInfo = ni.saveAs(ofolder,reportName);
   
   } catch (Exception ex) {
    ex.printStackTrace();
   } 

 }

}

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.microstrategy.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@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.