KB214031: How to Programmatically Pre-Populate the Prompt Answers for a Nested Prompt that has an Underlying Report as a Filter then Retrieve the New Prompt Answer XML with MicroStrategy Web SDK

SUMMARY: This Technical Note explains how a user can develop an add-on for the report page that will to programmatically pre-populate the prompt answers for a nested prompt that has an underlying report as a filter then retrieve the new prompt answer XML with Strategy Web SDK 9.4.x.
 
The following code demonstrates how to build an add-on with this functionality:    

    public void preCollectData(PageComponent page) {
    	
    	System.out.println("Pre-collect");
    	
    	String answerXML = "Your answer XML";
   	
    	 ReportBean rb = (ReportBean) page.getChildByClass(ReportBean.class);

    	try {
		rb.collectData();
	} catch (WebBeanException e) {
		// TODO Auto-generated catch block
		e.printStackTrace();
	}
    	 answerPromptsUsingAnswerXML(rb, answerXML);

    }

    public void postCollectData(PageComponent page) {
    	ReportBean rb = (ReportBean) page.getChildByClass(ReportBean.class);
        
        System.out.println("Post-collect");
        int status;

	try {
		rb.collectData();
		status = rb.getResultSetInstance().pollStatus();
		if (status == EnumDSSXMLStatus.DssXmlStatusResult) {
                   WebPrompts prompts = rb.getPromptsBean().getPrompts();
                   prompts.setClosed(false);
                   rb.collectData();
                   String newAnswerXML = prompts.getShortAnswerXML();
		 prompts.setClosed(true);
		 rb.collectData();
		 System.out.println("New answer XML:" + newAnswerXML + "\n");

		}
	} catch (WebObjectsException e) {
		e.printStackTrace();
	} catch (WebBeanException e) {
		e.printStackTrace();
	} catch (WebReportValidationException e) {
		e.printStackTrace();
	}
    	
    }
    

    private void answerPromptsUsingAnswerXML(ReportBean rb, String answerXML) {
    	
    	try {
		WebResultSetInstance instance = rb.getResultSetInstance();
		int status = instance.pollStatus();
		if (status == EnumDSSXMLStatus.DssXmlStatusPromptXML) {
		 WebPrompts prompts = instance.getPrompts();
		 prompts.populateAnswers(answerXML);
   	          rb.collectData();
		}

	} catch (Exception e) {
		// TODO: handle exception
	}

    	
    }
    

 
The above code works for most types of nested prompts. However, for nested prompts that use underlying reports as a filters, it is necessary to invoke the applyChanges() method from the ReportManipulator class. Thus, the try-catch block in postCollectData should be modified as follow:
 

try {
		rb.collectData();
		status = rb.getResultSetInstance().pollStatus();
		if (status == EnumDSSXMLStatus.DssXmlStatusResult) {
			WebReportInstance newInst = rb.getReportInstance().getReportManipulator().applyChanges();
                   newInst.setAsync(false);
                   int newstatus = newInst.pollStatus();
                   rb.collectData();
                   WebPrompts prompts = rb.getPromptsBean().getPrompts();
                   prompts.setClosed(false);
                   rb.getReportInstance().setAsync(false);
                   rb.getReportInstance().pollStatus();
                   rb.collectData();
                   String newAnswerXML = prompts.getShortAnswerXML();
		 prompts.setClosed(true);
		 rb.collectData();
		 System.out.println("New answer XML:" + newAnswerXML + "\n");

		}
	} catch (WebObjectsException e) {
		e.printStackTrace();
	} catch (WebBeanException e) {
		e.printStackTrace();
	} catch (WebReportValidationException e) {
		e.printStackTrace();
	}

 
 
 
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.