KB39427: How to Dynamically set the Filename Field when Creating an Email Subscription in Web Using the MicroStrategy Java Web SDK

This scenario shows how to dynamically set the filename field when creating an email subscription. This example uses a custom auto-text whose value is later retrieved in the code. This example also assumes that the report contains a single date prompt. This example can be further altered to suit the users need.

• In the Web Customization Editor, go to the Application Settings tab and expand the 'Pages' section.
• Scroll the list of pages to find the 'ncEditSubs' page. Click to expand the page.
•  Next expand 'Beans' > subFrame > ncSub
• RMC on ncSub bean and then select ‘New Event Handler
  

• In the Custom Event Handler Wizard, choose ‘Use Existing Event’ (SubscriptionBean should already be selected) and for the ‘Select Event ID’ choose ‘256003’ then click Next and then Finish.
  

• When the code appears, add the following under the case 256003 of the switch statement:
  
  
  

  
  if((event.getArgumentValue(256021)!=null)&& (event.getArgumentValue(256021).contains("{&Date1&}"))) {
  
         System.out.println("filename not null and contains prompt autotext ");
  
         SubscriptionBean sb = (SubscriptionBean)getWebComponent();
         
         if(sb==null)return super.handleDefaultRequest(keys);                   
  
         PromptsBean pb = sb.getPromptsBean();                   
         WebPrompts prompts = pb.getPrompts();
  
         //get the answer of date value prompt
         //TODO if there are multiple prompts, iterate through the prompt collection to get the appropriate prompt
  
         WebConstantPrompt wcp = (WebConstantPrompt)prompts.get(0);                   
         String answer = wcp.getAnswer();                   
  
         // This can be used if needed, since these characters cannot be used in a file name:*?"<>|/\
         // answer = answer.replace("/", "-");
  
         //test setting new file name in mode props
         WebSubscriptionDeliveryModeEmailProperties props = null;
  
         try {
               props = (WebSubscriptionDeliveryModeEmailProperties) sb.getSubscription().getDeliveryMode();
  
               //TODO instead of replacing the entire file name with the value, the customer can use String methods to
  
               //...parse the string and only replace the part where the custom autotext is located
               props.setFileName(answer);
               sb.getSubscription().save();
         } catch (WebBeanException e) {
               // TODO Auto-generated catch block
               e.printStackTrace();
         }     
         } catch (WebObjectsException e) {
               // TODO Auto-generated catch block
               e.printStackTrace();
         }     
         return super.handleDefaultRequest(keys);
         }               
  
  return super.handleDefaultRequest(keys);
  

  
  
  
  
•  Save the changes and  test in Web. 
   
  

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.