KB47560: How to Create a Simple Custom Feature that Qualifies on the Project a User is Currently in Using MicroStrategy Web SDK 10.x

SYMPTOM:
It is possible to create custom features for various purposes in the Web Customization Editor. This Technical Note shows how to create a simple custom feature that qualifies on the project a user is currently in.
 
ACTION:
Follow these steps to create the custom feature in the Web Customization Editor:
 
1. Create a Java class for the feature itself, called it CustomFeatures.java. A sample implementation is shown below:

package com.Strategy.sdk.samples.addons;

import com.Strategy.web.app.beans.AppContext;
import com.Strategy.web.beans.AggregatedWebFeatures;

public class CustomFeatures extends AggregatedWebFeatures {
	private String featureName = "isTutorial";
	private String projectName = "Strategy Tutorial";

	@Override
	public boolean resolveCustomFeature(String feature) {
		if (feature.equalsIgnoreCase(featureName)) {

			try {

				//Retrieve the project name
				String currentProjectNAME = ((AppContext) getWebComponent()
					.getBeanContext()).getAppSessionManager()
					.getActiveSession().getProjectName();

				//Check if this is the Tutorial project
				//String equalsIgnoreCase returns boolean value, which we can return
				return currentProjectNAME.equalsIgnoreCase(projectName);


			} catch (Exception e) {
				System.out.println("Exception" + e.toString());
			}
		}
		return true;
	}
}

 
2. Create an add-on class that will utilize the feature created in step 1, called it AggregatedFeaturesAddOn.java. A sample implementation is shown below:

package com.Strategy.sdk.samples.addons;
import com.Strategy.sdk.samples.addons.CustomFeatures;
import com.Strategy.web.app.addons.AbstractAppAddOn;
import com.Strategy.web.app.beans.PageComponent;
import com.Strategy.web.beans.ReportBean;

public class AggregatedFeaturesAddOn extends AbstractAppAddOn {

	public void postCollectData(PageComponent pg) {

		ReportBean rb = (ReportBean) pg.getChildByClass(ReportBean.class);

		if (rb != null) {
			CustomFeatures feature = new CustomFeatures();
			feature.aggregateFeatures(rb);

		}
	}

	public String getAddOnDescription() {

		// TODO Auto-generated method stub
		return null;

	}

}

 
3. In the Strategy perspective, navigate to the desired page to add the AggregatedFeaturesAddOn class created in step 2 to the Add-ons list
4. Restart the Web server
 
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 atsupport@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.