KB18358: How to Capture the Prompt Answers Supplied by the User at Runtime Using the MicroStrategy Java Web SDK

Using the Strategy Java Web SDK 9.4.1, it is possible to capture the prompt answers that a user enters in at runtime in an XML format.
 
The following code illustrates how to accomplish this with an add-on:
 

package customclasses.addons;

import com.Strategy.web.app.addons.AbstractAppAddOn;
import com.Strategy.web.app.beans.PageComponent;
import com.Strategy.web.beans.EnumRequestStatus;
import com.Strategy.web.beans.ReportBean;
import com.Strategy.web.beans.WebBeanException;
import com.Strategy.web.objects.WebObjectsException;
import com.Strategy.web.objects.WebPrompts;
import com.Strategy.web.objects.WebReportInstance;

public class GetAnswerXMLAddon extends AbstractAppAddOn {
 public void postCollectData(PageComponent page) { 
  ReportBean rb = (ReportBean) page.getChildByClass(ReportBean.class); 

  if (rb == null) return;
  try {
   if (rb.getObjectID().equalsIgnoreCase("9CDB05884A0D22AEE1CFBAA837198D42")) {

    if (rb.getXMLStatus() == EnumRequestStatus.WebBeanRequestSuccessful) {
     WebReportInstance oInst = rb.getReportInstance();
     WebPrompts oPrompts = oInst.getPrompts();
     oPrompts.setClosed(false);
     String strShortAnswerXML1 = oPrompts.getShortAnswerXML();
     System.out.println(strShortAnswerXML1);
     System.out.println("--------------------------------------------------------");
     String strEncodedAnsXML = oPrompts.getShortAnswerXML(true);
     System.out.println(strEncodedAnsXML);

     oPrompts.setClosed(true);
    }

   }

  } catch (WebBeanException e) {

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

   e.printStackTrace(); 
  }
 }

  

 public String getAddOnDescription()  {

  return "Shows how to get the answerXML from prompts the user has answered";
 }

}

 
 
 
For more information on how to implement add-ons in 9.4.1, see the link below:
 
Creating a New Add-on for a specified page
 
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 the MicroStrategy Developer Hub .
To access the Strategy Developer Hub, 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 Hub, 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.