KB219412: How to Modify View Filters Based on Attribute Form Qualifications Using MicroStrategy Web SDK

The view filter for a report can be modified programatically using the Strategy Web SDK 9.4.1.  The following sample modifies a report that has an existing view filter:

 
The view filter above is based on an attribute form qualification defined as Year ID equals 2011.  Attribute form qualifications are of type This filter is of type com.Strategy.webapi.EnumDSSXMLNodeType.DssXmlNodeConstant.  The following code sample modifies a view filter based on attribute form qualifications:

package com.Strategy.sdk.standalone;

import com.Strategy.web.beans.ExpressionBean;
import com.Strategy.web.beans.ReportBean;
import com.Strategy.web.beans.WebBeanFactory;
import com.Strategy.web.objects.WebConstantNode;
import com.Strategy.web.objects.WebExpression;
import com.Strategy.web.objects.WebFolder;
import com.Strategy.web.objects.WebIServerSession;
import com.Strategy.web.objects.WebNode;
import com.Strategy.web.objects.WebObjectsFactory;
import com.Strategy.web.objects.WebOperatorNode;
import com.Strategy.web.objects.WebReportInstance;
import com.Strategy.web.objects.WebReportManipulation;
import com.Strategy.webapi.EnumDSSXMLNodeType;
import com.Strategy.webapi.EnumDSSXMLReportSaveAsFlags;

public class ModifyViewFilter {

 public static void main(String[] args) throws Exception {
  WebObjectsFactory webObjectFactory;
  webObjectFactory = WebObjectsFactory.getInstance();
  WebIServerSession iServerSession;
  iServerSession = webObjectFactory.getIServerSession();     
  iServerSession.setServerName("Intelligence Server Name");
  iServerSession.setServerPort(0);
  iServerSession.setProjectName("Project Name");
  iServerSession.setLogin("username");
  iServerSession.setPassword("password");  

  /** The report to be modified */
  String reportID = "9952E3EF439A52336A3857A316045D0C";
  
  /** 
   * Get Report Bean
   * PURPOSE: To modify the View Filter information 
   */
  ReportBean rb = (ReportBean) WebBeanFactory.getInstance().newBean("ReportBean");
  rb.setSessionInfo(iServerSession);
  rb.setObjectID(reportID);
  
  // Retrieve Report Instance
  WebReportInstance reportInstance = rb.getReportInstance();
  reportInstance.setAsync(false);
  
  // Retrieve Original Folder Location
  WebFolder originalFolderLocation = rb.getParentFolderBean("fb").getFolderObject();
  String originalNameOfReport = rb.getDisplayName();
  
  /** 
   * Modify the View Filter
   */
  ExpressionBean eb = rb.getViewFilterBean();
  WebExpression exp = eb.getExpression();
  WebOperatorNode rootNode = (WebOperatorNode)exp.getRootNode();
  
  WebNode thisNode;
  WebNode childNode;
  WebConstantNode constantNode;
  
  for (int x=0; x<rootNode.getChildCount(); x++){
    thisNode = rootNode.getChild(x);

    for (int y=0; y<thisNode.getChildCount(); y++){
      childNode = thisNode.getChild(y);

      // A childNode type EnumDSSXMLNodeType.DssXmlNodeFormShortcut marks the beginning of an attribute form qualification
      if(childNode.getNodeType()==EnumDSSXMLNodeType.DssXmlNodeFormShortcut){
			  
      // Save the name of the current node to determine if this is the node to be modified 
      String thisNodeName = childNode.getDisplayName();
			  
      // Only modify the view filter if its "this" attribute
      if(thisNodeName.equalsIgnoreCase("YEAR\\ID")){
      
        // Increment the node to retrieve the filter information/type
        y++;
				  
        // Get this shortcut's node to modify its value
        childNode = thisNode.getChild(y);
				  
        // Check to see if this child node is of type EnumDSSXMLNodeType.DssXmlNodeConstant 
        if(childNode.getNodeType() == EnumDSSXMLNodeType.DssXmlNodeConstant){
          constantNode = (WebConstantNode)childNode;
          WebConstantNode newConstantNode = constantNode;
					  
            // Set the newConstantNode to desired value
            newConstantNode.setValue("2015");
          }
        }
      }
    }
  }
  eb.synchronize();
  
  // Apply changes
  WebReportManipulation rptManip = reportInstance.getReportManipulator();
  WebReportInstance newInst = rptManip.applyChanges();
  newInst.setSaveAsFlags(EnumDSSXMLReportSaveAsFlags.DssXmlReportSaveAsOverWrite);
  newInst.pollStatus();

  // Save report calling saveAs() method of WebReportInstance
  newInst.saveAs(originalFolderLocation, originalNameOfReport);


  }
}

 
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://community.strategy.com/topic/0TO44000000FliLGAS/sdk).
 
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/en/support/contact-support.
 
 
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.