KB12851: How to retrieve report SQL without executing the report in MicroStrategy Java Web SDK 9.x & 10.x

In Strategy Java Web SDK 9.x & 10.x, report SQL can be retrieved without executing the report. The Web Objects API call is the following:
 
com.Strategy.web.objects.WebReportData: getSQL()
 
This call returns the SQL for the current report.
 
The following two flags, EnumDssXMLExecutionFlags and EnumDssXMLResultFlags, must be set when creating new report instance for generating report SQL:
 

• EnumDSSXMLExecutionFlags.DssXmlExecutionGenerateSQL specifies an execution flag that instructs the report server to generate the SQL for report execution.
• EnumDSSXMLResultFlags.DssXmlResultXmlSQL specifies a flag to include the SQL for retrieving report execution results.

 
This sample code demonstrates how to get the report SQL without executing it in Strategy Java Web SDK 9.x & 10.x.
 

import com.Strategy.web.objects.*;
import com.Strategy.webapi.*;
public class GetReportSQL {
  
    public static void main(String[] args) {
      
        String SessionID = "";
      
        // Create factory object.
        WebObjectsFactory factory = WebObjectsFactory.getInstance();
        WebIServerSession serverSession = factory.getIServerSession();
      
        // Set up session properties by reading from the portlet properties/credentials vault.
        serverSession.setServerName("ServerName");
        serverSession.setServerPort(0);
        serverSession.setProjectName("ProjectName");
        serverSession.setLogin("Administrator");
        serverSession.setPassword("");
        serverSession.setApplicationType(EnumDSSXMLApplicationType.DssXmlApplicationCustomApp);
      
        try {
            SessionID = serverSession.getSessionID();
            System.out.println("Welcome " + serverSession.getLogin());
            System.out.println("SessionID: " + SessionID);
          
        } catch (WebObjectsException ex) {}
      
        WebReportSource oRepSource;
        WebObjectSource oObjSource;
        WebReportInstance oRWInstance;
      
        //get report source 
        oRepSource = factory.getReportSource();
      
        //specify report ID for Yearly Sales by Quarter
        String strReportID = "06D9AB5C4FBFEEB4B27D47BE0A117903";
      
        oRepSource.setResultFlags(EnumDSSXMLResultFlags.DssXmlResultXmlSQL);
        oRepSource.setExecutionFlags(EnumDSSXMLExecutionFlags.DssXmlExecutionGenerateSQL);
        try {
          
            //create report instance 
            oRWInstance = oRepSource.getNewInstance(strReportID);
            oRWInstance.setAsync(false);
            oRWInstance.setMaxWait(120000);
            oRWInstance.setPollingFrequency(250);
          
            int rpStatus = 0;
            rpStatus = oRWInstance.pollStatus();
          
            if (rpStatus != EnumDSSXMLStatus.DssXmlStatusResult) {
                System.out.println("Error:report status=" + rpStatus);
            }
          
            //retrieving report SQL from WebReportData object 
            WebReportData rpResultData = oRWInstance.getResults();
            String strSQL = "";
            strSQL = rpResultData.getSQL();
            System.out.println(strSQL);
        } catch (WebObjectsException woe) {
            System.out.println(woe.getMessage());
        }
    }
}

 
 
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.