KB439320: How to Programmatically Create an Object Prompt using the MicroStrategy Web SDK 10.9

It is possible to create an Object prompt through the Web SDK by utilizing both beans and events. In the following standalone code an object prompt named testprompt is created with the Customer attribute set in its predefined list of objects:
 

package com.sdk.standalone;

import com.Strategy.web.beans.BeanFactory;
import com.Strategy.web.beans.GenericRequestKeys;
import com.Strategy.web.beans.GenericWebEvent;
import com.Strategy.web.beans.PromptDefinitionBean;
import com.Strategy.web.beans.RequestKeys;
import com.Strategy.web.beans.WebBeanException;
import com.Strategy.web.beans.WebException;
import com.Strategy.web.objects.EnumWebPromptType;
import com.Strategy.web.objects.WebIServerSession;
import com.Strategy.web.objects.WebObjectsFactory;
import com.Strategy.web.objects.WebSessionInfo;

public class CreatePrompt {

	public static void main(String[] args) throws WebBeanException, WebException {
		// TODO Auto-generated method stub

		createPrompt();
	}
	
	public static WebIServerSession createSession()
	{
		WebObjectsFactory factory=WebObjectsFactory.getInstance();
		WebIServerSession serverSession = factory.getIServerSession();
		serverSession.setServerName("localhost");
		serverSession.setServerPort(0);
		serverSession.setProjectName("Strategy Tutorial");
		serverSession.setLogin("administrator");
		serverSession.setPassword("");		
		
		return serverSession;
		
	}
	
	
	public static void createPrompt() throws WebBeanException, WebException {
			BeanFactory bf = BeanFactory.getInstance();
			PromptDefinitionBean pdb = (PromptDefinitionBean) bf.newBean("PromptDefinitionBean"); 
			pdb.setSessionInfo((WebSessionInfo)createSession());
	
			//set to web object prompt
			pdb.setPromptType(EnumWebPromptType.WebPromptTypeObjects);
	
	
			RequestKeys frameKeys = new GenericRequestKeys();
			//This event corresponds to the "Use a pre-defined list of objects" option when creating an Object prompt
			// For more details see 'setElementsAvailList' in the PromptDefinitionBean of the event handler reference 
			frameKeys.add(GenericWebEvent.URL_EVENT_NAME, "4097016");
			frameKeys.add(GenericWebEvent.URL_SOURCE_NAME, "pdb.4097016");
			// A list of elements. In this example only Customer is added. 
			frameKeys.add("objectsList", "8D679D3C11D3E4981000E787EC6DE8A4~12~Customer");

			pdb.handleRequest(frameKeys);
			pdb.collectData();
			pdb.setName("testpromt");
			// Save the prompt in the Public Objects folder
			pdb.saveAs("testpromt", "testpromt", "98FE182C2A10427EACE0CD30B6768258", true);
			
			System.out.println("Done!");

		}

}

 
See to the Event Handlers Reference for more details regarding the events used on the PromptDefinitionBean .

 
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 the Strategy Developer Hub.
To access the Strategy Developer Hub, 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 Hub, 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. KB439320