KB42024: How to Convert a Report to a Datamart using the MicroStrategy Web SDK 9.4.x

The following code converts a report to a datamart using the Strategy SDK 9.4.x:

import com.Strategy.web.beans.BeanFactory;
import com.Strategy.web.beans.EnumReportBeanEvents;
import com.Strategy.web.beans.GenericRequestKeys;
import com.Strategy.web.beans.GenericWebEvent;
import com.Strategy.web.beans.ReportBean;
import com.Strategy.web.beans.RequestKeys;
import com.Strategy.web.beans.WebBeanException;
import com.Strategy.web.beans.WebEvent;
import com.Strategy.web.beans.WebException;
import com.Strategy.web.objects.WebIServerSession;
import com.Strategy.web.objects.WebObjectsException;
import com.Strategy.web.objects.WebObjectsFactory;
import com.Strategy.webapi.EnumDSSXMLApplicationType;
import com.Strategy.webapi.EnumDSSXMLDisplayMode;
import com.Strategy.webapi.EnumDSSXMLExecutionFlags;

public class ConvertToDatamartReportSample {

	/*
	 * Reference
	 *   MSDL Home > Web SDK > Customizing Strategy Web >
	 *   Part II: Advanced Customization Topics > Using the Web Objects API > Data Marts > Examples >
	 *   Converting a Report to a Data Mart Report Using Report Bean Events and Saving the Report Definition
	 */
	public static void main(String[] args) throws WebObjectsException, InterruptedException, WebBeanException, WebException {
		out("Begin Converting Report to Datamart");
		
		/** 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);
		
		/** Create Report Bean that will be converted to Datamart **/
		String reportID = "F74380A3435DCBF8C2F3AA9AE8A06AE9";
		ReportBean bean = getReportBean(reportID, serverSession);
		bean.collectData();
		
		WebEvent we = bean.getWebEvent(EnumReportBeanEvents.REPORT_EVENT_DEFINE_DATAMART);
		
		/* Allocates arguments for converting to Datamart Report */
		RequestKeys mr = new GenericRequestKeys();
		mr.add(GenericWebEvent.URL_EVENT_NAME, String.valueOf(EnumReportBeanEvents.REPORT_EVENT_DEFINE_DATAMART));
		mr.add(we.getArgumentName(EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DM_TABLE_NAME), "Datamart_Table");
		
		// Indicates a Table Name
		mr.add(we.getArgumentName(EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DM_NAME_MACRO), "1");
		mr.add(we.getArgumentName(EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DM_APPEND), "1");
		mr.add(we.getArgumentName(EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DB_ROLE_ID), "BCB3836D4C70EDF53CB706ABA556B44B");
		
		// Indicates a DB role
		bean.handleRequest(mr);
		bean.collectData();
		WebEvent weSave = bean.getWebEvent(EnumReportBeanEvents.REPORT_EVENT_SAVE_AS);
		
		/* Save a Datamart Report that has been converted */
		RequestKeys mrSave = new GenericRequestKeys();
		mrSave.add(GenericWebEvent.URL_EVENT_NAME, String.valueOf(EnumReportBeanEvents.REPORT_EVENT_SAVE_AS));
		mrSave.add(weSave.getArgumentName(EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SAVE_AS_NAME), "Datamart_Converted");
		
		// Indicates a Report Name
		mrSave.add(weSave.getArgumentName(EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SAVE_AS_PARENT_FOLDER_ID), "405B7C934826C3ED08CCF9B6653D4845");
		
		// Indicates the folder in which the datamart report will be saved
		mrSave.add(weSave.getArgumentName(EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DISPLAY_FLAGS), String.valueOf(EnumDSSXMLDisplayMode.DssXmlDisplayModeDatamart));
		bean.handleRequest(mrSave);
		String newReportID = bean.getObjectID();
		ReportBean datamart = getReportBean(newReportID, serverSession);
		datamart.setExecutionFlags(EnumDSSXMLExecutionFlags.DssXmlExecutionGenerateDatamart);
		
		// Insert a data to the table indicated above when it executes the datamart Report
		datamart.collectData();
		// Executes the datamart Report
		
		/** Close I-Server Session **/
		serverSession.closeSession();
		out("Finished Converting Report to Datamart");

	}
	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);

	}
}

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.