KB42023: How to Output All Elements for All Attribute Element Prompts on a Report using the MicroStrategy Web SDK 9.3.0

The following sample code will iterate through all prompts for any given report and output the elements for all the Attribute Elements Prompts:
 

import com.Strategy.web.beans.BeanFactory;
import com.Strategy.web.beans.ReportBean;
import com.Strategy.web.beans.WebBeanException;
import com.Strategy.web.objects.WebElementSource;
import com.Strategy.web.objects.WebElements;
import com.Strategy.web.objects.WebElementsPrompt;
import com.Strategy.web.objects.WebIServerSession;
import com.Strategy.web.objects.WebObjectsException;
import com.Strategy.web.objects.WebObjectsFactory;
import com.Strategy.web.objects.WebPrompt;
import com.Strategy.web.objects.WebPrompts;
import com.Strategy.webapi.EnumDSSXMLApplicationType;

public class testingTechnote {
	public static void main(String arg[]) throws WebObjectsException, WebBeanException{
		
		/** Create I-Server Session **/
		WebObjectsFactory factory = WebObjectsFactory.getInstance();
		WebIServerSession serverSession = factory.getIServerSession();
		serverSession.setServerName("localhost");
		serverSession.setServerPort(0);
		serverSession.setProjectName("Strategy Tutorial");
		serverSession.setLogin("administrator");
		serverSession.setPassword("");
		serverSession.setApplicationType(EnumDSSXMLApplicationType.DssXmlApplicationCustomApp);
		
		String reportID = "AB85385646129B5083A302A09F5BA800";
		ReportBean rb = getReportBean(reportID, serverSession);
		
		/** OUTPUT PROMPT ELEMENTS **/
		WebPrompts prompts = rb.getReportInstance().getPrompts();
		
		// This code will iterate through all prompts
		for(int x=0; x<prompts.size(); x++){
			// Get the prompt at index x
			WebPrompt prompt = prompts.get(x);
			
			// If this is an element prompt (type = 2)
			if(prompt.getPromptType()==2){
				//Get the elements
				WebElementsPrompt welp= (WebElementsPrompt)prompt;
				WebElementSource eltsrc=welp.getOrigin().getElementSource();
				WebElements elements =eltSrc.getElements();
				
				//Outputting the source of elements
				out("Prompt Name = " + welp.getName());
				
				//Iterate through each element
				for(int e = 0 ; e<elements.size() ; e++){
					String elemName = elements.get(e).getDisplayName();
					// Outputting each element
					out("Element Name = " + elemName);
				}
			}
		}
		
		/** Close I-Server Session **/
		serverSession.closeSession();
	}
	
	public static ReportBean getReportBean(String reportID, WebIServerSession session) {
		/** Create a new Bean instance **/
		ReportBean rb = (ReportBean) BeanFactory.getInstance().newBean("ReportBean");
		
		/** Assuming a session has already been made
		*  Setting the session to the report bean
		*  Setting the reportID to the report bean **/
		rb.setSessionInfo(session);
		rb.setObjectID(reportID);
		
		/** Return the ReportBean **/
		return rb;
	}
	
	public static void out(String s){
		System.out.println(s);
	}
	
}

 
 
Sample Output
 

Prompt Name = Elements of Year
Element Name = 2009
Element Name = 2010
Element Name = 2011
Element Name = 2012
Prompt Name = Elements of Quarter
Element Name = 2009 Q1
Element Name = 2009 Q2
Element Name = 2009 Q3
Element Name = 2009 Q4
Element Name = 2010 Q1
Element Name = 2010 Q2
Element Name = 2010 Q3
Element Name = 2010 Q4
Element Name = 2011 Q1
Element Name = 2011 Q2
Element Name = 2011 Q3
Element Name = 2011 Q4
Element Name = 2012 Q1
Element Name = 2012 Q2
Element Name = 2012 Q3
Element Name = 2012 Q4

 
  
The example provided in this document is provided “as-is” to the user and assumes that the user:

• Can program, compile (e.g. javac, jikes, etc.), and execute Java programs
• Can configure environment variables (e.g. JAR files, property files, etc.)
• Have all the necessary tools to create Java applications (JDK, IDE, etc.)
• Has access to the Strategy SDK documentation.
• Has read the customization warning at the bottom of this document

PREREQUISITES:
For the sample to work, the Strategy Web JAR files must be accessible by the Java Runtime
Environment. The Strategy Web JAR files can be found under:

• Strategy Web Universal (JSP): {web_root}/WEB-INF/lib directory.
• Strategy Web (.NET): Program Files\Common Files\Strategy directory.

Note:
More elaborate programs will require additional library files and are out of the scope of this document.
 
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.