EducationSoftwareStrategy.com
StrategyCommunity

Knowledge Base

Product

Community

Knowledge Base

TopicsBrowse ArticlesDeveloper Zone

Product

Download SoftwareProduct DocumentationSecurity Hub

Education

Tutorial VideosSolution GalleryEducation courses

Community

GuidelinesGrandmastersEvents
x_social-icon_white.svglinkedin_social-icon_white.svg
Strategy logoCommunity

© Strategy Inc. All Rights Reserved.

LegalTerms of UsePrivacy Policy
  1. Home
  2. Topics

KB38234: How to save and overwrite a report using the MicroStrategy Web SDK 9.3.x-9.5.x


Community Admin

• Strategy


Java example demonstrating the process of saving a report using the MicroStrategy Web API.

The following sample code demonstrates how to save and overwrite a specific report using the Strategy Web SDK.


package com.Strategy.sdk.standalone;
import com.Strategy.web.objects.WebFolder;
import com.Strategy.web.objects.WebIServerSession;
import com.Strategy.web.objects.WebObjectInfo;
import com.Strategy.web.objects.WebObjectSource;
import com.Strategy.web.objects.WebObjectsException;
import com.Strategy.web.objects.WebObjectsFactory;
import com.Strategy.web.objects.WebReportInstance;
import com.Strategy.web.objects.WebReportSource;
import com.Strategy.webapi.EnumDSSXMLObjectTypes;
import com.Strategy.webapi.EnumDSSXMLReportSaveAsFlags;

public class SaveReport {
	public static WebObjectsFactory factory = null;
	public static WebIServerSession serverSession = null;
	public static WebFolder folder = null;

	public static void main(String[] args) throws WebObjectsException {
		saveReport();
	}

	public static void saveReport() throws WebObjectsException {

		//Creates WebIServerSession by using the getSession() method that hardcodes in the credentials for the session
		WebIServerSession serverSession = getSession();
		// Specify a particular report ID
		String reportID = "BB05BD784902E7E6E4DF80960A2016E2"; // report dssID

		// Get report's parent folder in order to use the save as function
		WebObjectSource objSource = serverSession.getFactory().getObjectSource();
		folder = (WebFolder) objSource.getObject(reportID, EnumDSSXMLObjectTypes.DssXmlTypeReportDefinition).getParent();
		WebObjectInfo oReport = objSource.getObject(reportID, EnumDSSXMLObjectTypes.DssXmlTypeReportDefinition, true);
		String rptName = oReport.getName();

		//Create the WebReportSource object which is the entry point to the report execution and manipulation functionality
		WebReportSource reptsrc = serverSession.getFactory().getReportSource();
		WebReportInstance rptInst = reptSrc.getNewInstance(reportID);

		//Set the save as flag to enable over-writing then save the report instance
		rptInst.setSaveAsFlags(EnumDSSXMLReportSaveAsFlags.DssXmlReportSaveAsOverWrite);
		rptInst.saveAs(folder, rptName);
	}

	public static WebIServerSession getSession() {
		//Static creation of WebIServerSession
		WebIServerSession isess = null;
		isess = WebObjectsFactory.getInstance().getIServerSession();
		isess.setServerName("SERVERNAME");
		isess.setServerPort(0);
		isess.setProjectName("PROJECTNAME");
		isess.setLogin("USERNAME");
		isess.setPassword("");
		return isess;
	}

}

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.microstrategy.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@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.


Comment

0 comments

Details

Knowledge Article

Published:

April 17, 2017

Last Updated:

April 17, 2017