KB44011: How to Modify the Email Subject for the Send Now Page by Adding Custom Text Using the MicroStrategy Web SDK 9.4.1

The subject line in the Send Now editor can be modified using the Strategy Web SDK by creating an add-on directly on the rwd (Report Writing Documents) page or on the report (Report Execution) page using the postCollectData method.
 
The beans that will be needed are the following: SubscriptionEditorBean, SubscriptionBean, and the RWBean (or the ReportBean). The SubscriptionBean is contained within the SubscriptionEditorBean. It is important to call the SubscriptionEditorBean's isOpen method before attempting to adjust the email subject otherwise a NullPointerException will be thrown. More importantly, there are several SubscriptionEditorBeans contained on the page. As shown in KB38524, it will be necessary to iterate through all of the beans on the page and retrieve the specific SubscriptionEditorBean needed for this customization.
 
Finally, the RWBean (or the ReportBean) can be used to save the original subject before setting a new value in the SubscriptionBean. The best method to use for this purpose would be the getObjectName method. As previously noted, KB38524 shows an example of manipulating the subject using the SubscriptionBean.
 
Below is sample code for completing this add-on:
 

/**
 * Strategy SDK Sample
 *
 * Copyright © 2011 Strategy Incorporated. All Rights Reserved.
 *
* Strategy MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE 
 * SUITABILITY OF THIS SAMPLE CODE, EITHER EXPRESS OR IMPLIED, INCLUDING 
 * BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS 
 * FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. Strategy SHALL NOT 
 * BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, 
 * MODIFYING OR DISTRIBUTING THIS SAMPLE CODE OR ITS DERIVATIVES.
 *
 *
 */

package com.Strategy.sdk.examples.addons;

import com.Strategy.web.app.addons.AbstractAppAddOn;
import com.Strategy.web.app.beans.PageComponent;
import com.Strategy.web.app.beans.SubscriptionEditorBean;
import com.Strategy.web.beans.RWBean;
import com.Strategy.web.beans.SubscriptionBean;
import com.Strategy.web.beans.WebBeanException;
import com.Strategy.web.beans.WebComponent;
import com.Strategy.web.objects.WebSubscription;
import com.Strategy.web.objects.WebSubscriptionDeliveryModeEmailProperties;


public class ModifyEmailSubject extends AbstractAppAddOn {
 private SubscriptionEditorBean seb;
 private SubscriptionBean sb;
 private RWBean rwb;
 
    public String getAddOnDescription() {
        return "This add-on will add custom text into the subject field.";
    }

    public void postCollectData(PageComponent page) {
     System.out.println("Method Called: postCollectData");
     seb = getSubscriptionEditorBean(page);
     rwb = (RWBean) page.getChildByClass(RWBean.class);
     
     if (seb.isOpen()) {
      try {
       sb = seb.getSubscriptionBean();
     WebSubscription ws = sb.getSubscription();
     WebSubscriptionDeliveryModeEmailProperties emailProp = (WebSubscriptionDeliveryModeEmailProperties) ws.getDeliveryMode();
     
     // Default subject is the report name
     String prevSubject = rwb.getObjectName();
     emailProp.setEmailSubject(" "+prevSubject);
     
     sb.collectData();
    } catch (WebBeanException e) {
     e.printStackTrace();
    }
     }
        return;
    }
    
    private SubscriptionEditorBean getSubscriptionEditorBean(WebComponent wc) {
     SubscriptionEditorBean result = null;
   // There are multiple SubscriptionEditorBeans on the page; recursively iterate through all of the page beans to retrieve the correct bean
     if (wc instanceof SubscriptionEditorBean) {
      if (wc.getName().equals("ncSendNow")) result = (SubscriptionEditorBean) wc;
     } else {
      for (int i = 0; i < wc.getChildCount(); i++) {
       result = getSubscriptionEditorBean(wc.getChild(i));
       if (result != null) break;
      }
     }
     return result;
    }

}

 
 
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.