KB249032: Appending a Custom Prefix to Subscription Names When Creating or Editing Subscriptions in Microstrategy Web 9.5.x

This Technical Note contains an example that can be used to append a prefix to subscription names, when creating or editing subscriptions in Strategy Web.
 
Using the Web Customization Editor to create this customization:
Strategy SDK provides a Web Customization Editor that can be used to create a customization plug-in. The following steps guide users in creating the plug-in for adding the user history list to the Desktop page:

1. Launch the Web Customization Editor
2. Create a new plug-in and give it a meaningful name. (For step by step instructions on creating a new plug-in, please navigate toHome > Web SDK > Customizing Strategy Web > Web Customization Editor > Features and Customizable Settings)
3. Select the "Application Settings" tab and expand "Strategy Web Configuration" to view the hiearchical tree.
4. Navigate to Pages, and locate the "ncSubsConfirm" page.
5. Right-click on this page and select "Create New Add-on" to open the Add-on creation Wizard.

 
Sample add-on code:

/**
 * 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-IN *
 *
 */


import com.Strategy.web.app.addons.AbstractAppAddOn;
import com.Strategy.web.app.beans.PageComponent;
import com.Strategy.web.beans.RequestKeys;
import com.Strategy.web.beans.SubscriptionBean;
import com.Strategy.web.beans.WebBeanException;
import com.Strategy.web.beans.WebComponent;
import com.Strategy.web.objects.WebObjectsException;


public class DynamicSubNames extends AbstractAppAddOn { 
	
    public String getAddOnDescription() {
        return "";
    }
    
    public String getCustomPrefix(){
    	return "CUSTOM PREFIX";
    }
    
    public void preCollectData(PageComponent page) {
    	System.out.println("preCollectData");
    	SubscriptionBean sb;
		try {
	    	sb = getSubscriptionBean(page);
	    	// Check prefix hasn't already been applied
	    	if(!sb.getSubscription().getName().contains(getCustomPrefix())){
	    		// Set custom prefix
	    		sb.getSubscription().setName(getCustomPrefix()+sb.getSubscription().getName());
	    		sb.getSubscription().save();
	    	}
		} catch (WebBeanException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (WebObjectsException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
        return;
    }
    
    // Custom method to retrieve the subscriptiion bean from WebComponent
    private SubscriptionBean getSubscriptionBean(WebComponent wc) {     
    	SubscriptionBean result = null;   
    	if (wc instanceof SubscriptionBean) { 
    		System.out.println("wc.getname :"+wc.getName());
    			result = (SubscriptionBean) wc;     
    		} 
    	else
    		{      
    		for (int i = 0; i < wc.getChildCount(); i++) {       
    			result = getSubscriptionBean(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.Strategy.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@Strategy.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.Strategy.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.