KB38163: How Can Users Edit an Existing Subscription, Modify the Prompt Answers and Save It Using MicroStrategy SDK?

The sample code below shows how users can personalize the prompt answers for an existing report subscription and save it back to the Metadata with the new prompt answers using Strategy SDK version 9.x.
 

import com.Strategy.web.objects.EnumWebSubscriptionContentTypes;
import com.Strategy.web.objects.SimpleList;
import com.Strategy.web.objects.WebElements;
import com.Strategy.web.objects.WebElementsPrompt;
import com.Strategy.web.objects.WebIServerSession;
import com.Strategy.web.objects.WebObjectInfo;
import com.Strategy.web.objects.WebObjectSource;
import com.Strategy.web.objects.WebObjectsFactory;
import com.Strategy.web.objects.WebPrompts;
import com.Strategy.web.objects.WebSubscription;
import com.Strategy.web.objects.WebSubscriptionContent;
import com.Strategy.web.objects.WebSubscriptionContentReport;
import com.Strategy.web.objects.WebSubscriptionsSource;
import com.Strategy.webapi.EnumDSSXMLApplicationType;
import com.Strategy.webapi.EnumDSSXMLObjectTypes;

public class EditSubscriptionWithPrompts {
 private static WebObjectsFactory factory;
      Private static WebIServerSession serverSession;
 public static void main(String[] args) throws Exception {
  try {
   createSession();
   editSubscription();
  } finally {
   closeSession();
  }
 }
 static void createSession() throws Exception {
  factory = WebObjectsFactory.getInstance();
  serverSession = factory.getIServerSession();
  serverSession.setServerName("SERVER_NAME");
  serverSession.setServerPort(0);
  serverSession.setProjectName("PROJECT_NAME");
  serverSession.setLogin("USER_ID");
  serverSession.setPassword("");
  serverSession.setApplicationType(EnumDSSXMLApplicationType.DssXmlApplicationCustomApp);
  String sessionID = serverSession.getSessionID();
 }
 static void closeSession() throws Exception {
 WebIServerSession serverSession = factory.getIServerSession();
  if (serverSession != null) {
   serverSession.closeSession();
  }
 }

 static void editSubscription() throws Exception {
  WebObjectSource mysource = factory.getObjectSource(); 
   //Get the report for which the subscription has been created
        WebObjectInfo myreport = mysource.getObject("E9CC66724445EC9EF03A32B95DBDB570", EnumDSSXMLObjectTypes.DssXmlTypeReportDefinition, true);
  WebSubscriptionsSource subSource =serverSession.getFactory().getSubscriptionsSource(); 
  SimpleList list = subSource.getSubscriptions(myreport);
  WebSubscription sub = null;
  WebSubscriptionContentReport content = null;
  //Get the first subscription defined on the report
  sub = (com.Strategy.web.objects.WebSubscription) list.item(0); 
  //Get the subscription content report from which the prompts defined on the subscription can be accessed
      WebSubscriptionContentReport contentReport = (WebSubscriptionContentReport) getSubscriptionContent(sub);

      //Check if the subscription has prompts defined on it
  if (contentReport.isPersonalized()) {
            //If the subscription contains prompts call reprompt 
   contentReport.reprompt();
 //Get the prompts defined clear the elements and add new elements before answering the prompts
   WebPrompts prompts = contentReport.getPrompts();
   WebElementsPrompt prompt = (WebElementsPrompt) prompts.get(0);
   WebElements elements = prompt.getAnswer();
   elements.clear();
   elements.add("8D679D4B11D3E4981000E787EC6DE8A4:1", "Northeast");
   elements.add("8D679D4B11D3E4981000E787EC6DE8A4:6", "Northwest");
   prompt = (WebElementsPrompt) prompts.get(1);
   elements = prompt.getAnswer();
   elements.clear();
   
   elements.add("8D679D5111D3E4981000E787EC6DE8A4:2010", "2010");
   elements.add("8D679D5111D3E4981000E787EC6DE8A4:2011", "2011");
   prompts.answerPrompts();
   //Save the subscription after the prompts have been resolved
   if (contentReport.isResolved()) {
    sub.save();
   }
  }
 }

 static WebSubscriptionContent getSubscriptionContent(WebSubscription sub)
 throws Exception {
  WebSubscriptionContent content = sub.getContent();
  WebSubscriptionContentReport contentReport = null;
  int contentType = content.getContentType();
 if (contentType == EnumWebSubscriptionContentTypes.CONTENT_TYPE_REPORT) {
   contentReport = (WebSubscriptionContentReport) content;
  }
  return contentReport;
 }
}

 
 
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.