Package com.microstrategy.webapi

Interface IDSSXMLReportServer

  • public interface IDSSXMLReportServer
    This interface provides the functionality for an application to execute a report by report ID, filter/template ID and report definition. It also provides methods to get a report execution result, cancel a report execution, answer a report prompt, and rebuild a report's layout (i.e., pivoting, sorting). Note that this inteface can be used to send a datamart report execution request to the server--see the Execute method documentation for details.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String AnswerPrompt​(java.lang.String sessionID, java.lang.String messageID, java.lang.String promptAnswer, int executionFlags, int resultFlags, java.lang.String viewSettings, java.lang.String windowSetting, java.lang.String styleXSL, java.lang.String webProperties, IntWrapper status)
      This method answers a prompt and lets the report execution continue.
      byte[] BinaryExportAsync​(java.lang.String sessionID, java.lang.String messageID, int exportFormat, IntWrapper iwStatus)
      Returns the exported data in a binary format (for instance while retrieving PDF data).
      java.lang.String BrowseReportAsJson​(java.lang.String sessionID, java.lang.String messageID, int browseReportFlag, int bindingTableObjectType, int dataPreviewJsonFlag, int autoMapFlag)
      Obtains the JSON result/data of the report from IServer.
      java.lang.String BrowseReportAsJson​(java.lang.String sessionID, java.lang.String messageID, java.lang.String tableName, java.lang.String attrName, java.lang.String metricName, int browseReportFlag, int bindingTableObjectType, int dataPreviewJsonFlag, int autoMapFlag)
      Obtains the JSON result/data of the report from IServer.
      java.lang.String ChangeImportedCube​(java.lang.String sessionID, java.lang.String reportID, int sheetIndex, java.lang.String colHeaders, boolean isUrl, java.lang.String transformations, int executionFlags, int resultFlags, java.lang.String extParam, StringWrapper msgID, IntWrapper status)
      Change the sheet index or insert new column headers on a imported cube
      java.lang.String ChangeImportedCube​(java.lang.String sessionID, java.lang.String reportID, int sheetIndex, java.lang.String colHeaders, boolean isUrl, java.lang.String transformations, java.lang.String dbRoleID, java.lang.String sourceAccountID, int executionFlags, int resultFlags, int behaviorFlags, java.lang.String extParam, StringWrapper msgID, IntWrapper status)
      Change the sheet index or insert new column headers on a imported cube, with support to cubes imported form OAuth source, and support idc behavior change flag
      java.lang.String ChangeImportedCube​(java.lang.String sessionID, java.lang.String reportID, int sheetIndex, java.lang.String colHeaders, boolean isUrl, java.lang.String transformations, java.lang.String dbRoleID, java.lang.String sourceAccountID, int executionFlags, int resultFlags, int behaviorFlags, java.lang.String extParam, StringWrapper msgID, IntWrapper status, java.lang.String documentID)
      Change the sheet index or insert new column headers on a imported cube, with support to cubes imported form OAuth source, and support idc behavior change flag
      java.lang.String CubeExecuteSearch​(java.lang.String sessionID, java.lang.String cubeSources, java.lang.String searchXML, int blockBegin, int blockCount, int searchFlags, int workingSetSearchFlags)
      Returns search results for executing a search within a cube.
      void Drill​(java.lang.String sessionID, java.lang.String messageID, java.lang.String drillTransformation, int viewIndex, int stateID, StringWrapper drillMsgID)
      This method performs drill operations on a report.
      java.lang.String Execute​(ReportExecuteParams reportExecuteParams, StringWrapper msgID, IntWrapper status)
      This method executes a report by report ID.
      java.lang.String Execute​(java.lang.String sessionID, java.lang.String reportID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String viewSetting, java.lang.String windowSetting, java.lang.String extParams, int requestTimeout, java.lang.String styleXSL, java.lang.String webProperties, StringWrapper msgID, IntWrapper status)
      This method executes a report by report ID.
      java.lang.String Execute​(java.lang.String sessionID, java.lang.String reportID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String viewSetting, java.lang.String windowSetting, java.lang.String extParams, int requestTimeout, java.lang.String styleXSL, java.lang.String webProperties, StringWrapper msgID, IntWrapper status, java.lang.String subscriptionID)
      This method executes a report by report ID.
      java.lang.String Execute​(java.lang.String sessionID, java.lang.String reportID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String viewSetting, java.lang.String windowSetting, java.lang.String styleXSL, java.lang.String webProperties, StringWrapper msgID, IntWrapper status)
      This method executes a report by report ID.
      java.lang.String Execute​(java.lang.String sessionID, java.lang.String reportID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String viewSetting, java.lang.String windowSetting, java.lang.String extParams, java.lang.String styleXSL, java.lang.String webProperties, StringWrapper msgID, IntWrapper status)
      This method executes a report by report ID.
      java.lang.String ExecuteFT​(java.lang.String sessionID, java.lang.String filterID, java.lang.String templateID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String viewSetting, java.lang.String windowSetting, java.lang.String styleXSL, java.lang.String webProperties, StringWrapper msgID, IntWrapper status)
      This method executes a report by a combination of a filter ID and a template ID.
      java.lang.String Export​(java.lang.String sessionID, java.lang.String messageID, int exportFormat, java.lang.String export_parameter, int stateID, IntWrapper status)
      Returns the report in a comma-delimited format.
      java.lang.String GetBinaryFileContent​(java.lang.String sessionID, java.lang.String fileName, java.lang.String fileType, long fileLength, java.io.InputStream data, int maxNumElements, boolean preserveWhiteSpace, java.lang.String outputDelimiter)
      Obtains the result/data of the binary file from backend
      java.lang.String GetCubeElements​(java.lang.String sessionID, java.lang.String objectID, int type, java.lang.String filter, int blockBegin, int blockCount, java.lang.String cubeSources)  
      java.lang.String GetCubeObjects​(java.lang.String sessionID, int blockBegin, int blockCount, java.lang.String cubeSources)  
      byte[] GetCubeResultsInBinary​(java.lang.String sessionID, java.lang.String reportID, java.lang.String messageID, int sheetIndex, int resultFlags, int detailFlags, int stateID, java.lang.String extendableParameter, IntWrapper iwStatus)
      Obtains the result/data of the cube from backend in bytes.
      java.lang.String GetExecutionResults​(java.lang.String sessionID, java.lang.String messageID, int resultFlags, java.lang.String windowSetting, java.lang.String styleXSL, int stateID, IntWrapper status)
      This method retrieves the results of report execution.
      IResultsAsStream GetExecutionResultsAsStream​(java.lang.String sessionID, java.lang.String messageID, int resultFlags, java.lang.String windowSetting, int stateID, java.lang.String extendableParameter)
      This method retrieves the results of report execution and returns them to the caller as a stream.
      java.lang.String GetExecutionResultsEx​(java.lang.String sessionID, java.lang.String messageID, int resultFlags, java.lang.String windowSetting, int stateID, java.lang.String extendableParameter, IntWrapper status)
      This method retrieves the results of report execution.
      byte[] GetExecutionResultsInBinary​(java.lang.String sessionID, java.lang.String messageID, int resultFlags, int detailFlags, int stateID, java.lang.String extendableParameter, IntWrapper iwStatus)
      Obtains the results/data of the report in binary format.
      java.lang.String GetExportResults​(java.lang.String sessionID, java.lang.String messageID, int format, IntWrapper status)
      Returns export results in the given format for the given report.
      java.lang.Object GetJsonResults​(java.lang.String sessionID, java.lang.String messageID, int resultFlags, int detailFlags, java.lang.String windowSetting, int stateID, java.lang.String extendableParameter, int mode, int version, IntWrapper status)
      THIS METHOD IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT.
      java.lang.Object GetJsonResults​(java.lang.String sessionID, java.lang.String messageID, int resultFlags, int detailFlags, java.lang.String windowSetting, int stateID, java.lang.String extendableParameter, int mode, IntWrapper status)
      THIS METHOD IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT.
      java.lang.String GetProjectDISettings​(java.lang.String sessionID, java.lang.String projectID)
      return the project settings specific for data import.
      java.lang.String GetPromptAnswer​(java.lang.String sessionID, java.lang.String messageID)
      This method retrieves a prompt answer.
      java.lang.String GetPromptAnswerEx​(java.lang.String sessionID, java.lang.String messageID, java.lang.String extendableParameter)
      This method retrieves a prompt answer.
      java.lang.String GetReportElements​(java.lang.String sessionID, java.lang.String messageID, java.lang.String objectID, int type, java.lang.String filter, int blockBegin, int blockCount)
      Returns the elements within the working set of a specific report for a given object.
      java.lang.String GetReportElements​(java.lang.String sessionID, java.lang.String messageID, java.lang.String objectID, int type, java.lang.String filter, int blockBegin, int blockCount, int flags)
      Returns the elements within the working set of a specific report for a given object.
      java.lang.String GetReportElements​(java.lang.String sessionID, java.lang.String messageID, java.lang.String objectID, int type, java.lang.String filter, java.lang.String forms, int blockBegin, int blockCount, int flags)
      Returns the elements within the working set of a specific report for a given object.
      java.lang.String GetUserDICubeInfo​(java.lang.String sessionId, java.lang.String projectId, java.lang.String userId, int option)
      Get DI cube info for project and specified user
      boolean HasPromptAnswer​(java.lang.String sessionID, java.lang.String messageID, StringWrapper promptAnswer)
      Returns whether the report(identified by the given message ID) has prompt answers and retrieves the prompt answer for the given Message ID, if any.
      boolean HasPromptAnswerEx​(java.lang.String sessionID, java.lang.String messageID, StringWrapper promptAnswer, java.lang.String extendableParameter)
      Returns whether the report(identified by the given message ID) has prompt answers and retrieves the prompt answer for the given Message ID, if any.
      java.lang.String ImportCube​(java.lang.String sessionID, java.lang.String reportID, java.lang.String url, int executionFlags, int resultFlags, int behaviorFlags, java.lang.String extParam, java.lang.String documentID, StringWrapper msgID, IntWrapper status)
      Create a cube on the IServer based on a file at the specified url
      java.lang.String ImportCube​(java.lang.String sessionID, java.lang.String reportID, java.lang.String url, int executionFlags, int resultFlags, java.lang.String extParam, StringWrapper msgID, IntWrapper status)
      Create a cube on the IServer based on a file at the specified url
      java.lang.String ImportCube​(java.lang.String sessionID, java.lang.String reportID, java.lang.String url, int executionFlags, int resultFlags, java.lang.String extParam, java.lang.String documentID, StringWrapper msgID, IntWrapper status)
      Create a cube on the IServer based on a file at the specified url
      java.lang.String ImportCube​(java.lang.String sessionID, java.lang.String reportID, java.lang.String fileName, java.lang.String fileType, long fileLength, java.io.InputStream data, int executionFlags, int resultFlags, int behaviorFlags, java.lang.String extParam, java.lang.String documentID, StringWrapper msgID, IntWrapper status)
      Create a cube on the IServer based on the file passed in
      java.lang.String ImportCube​(java.lang.String sessionID, java.lang.String reportID, java.lang.String fileName, java.lang.String fileType, long fileLength, java.io.InputStream data, int executionFlags, int resultFlags, java.lang.String extParam, StringWrapper msgID, IntWrapper status)
      Create a cube on the IServer based on the file passed in
      java.lang.String ImportCube​(java.lang.String sessionID, java.lang.String reportID, java.lang.String fileName, java.lang.String fileType, long fileLength, java.io.InputStream data, int executionFlags, int resultFlags, java.lang.String extParam, java.lang.String documentID, StringWrapper msgID, IntWrapper status)
      Create a cube on the IServer based on the file passed in
      java.lang.String ImportCube​(java.lang.String sessionID, java.lang.String messageID, java.lang.String tableID, java.lang.String reportID, java.lang.String url, int executionFlags, int resultFlags, int behaviorFlags, java.lang.String extParam, java.lang.String documentID, StringWrapper msgID, IntWrapper status)
      Create a cube on the IServer based on a file at the specified url, with support to msgID and tableID for EMMA cube
      java.lang.String ImportCube​(java.lang.String sessionID, java.lang.String messageID, java.lang.String tableID, java.lang.String reportID, java.lang.String fileName, java.lang.String fileType, long fileLength, java.io.InputStream data, int executionFlags, int resultFlags, int behaviorFlags, java.lang.String extParam, java.lang.String documentID, StringWrapper msgID, IntWrapper status)
      Create a cube on the IServer based on the file passed in, with support to EMMA msgID and source table ID
      java.lang.String ImportCube​(java.lang.String sessionID, java.lang.String messageID, java.lang.String tableID, java.lang.String reportID, java.lang.String fileName, java.lang.String fileType, long length, java.lang.String numOfChunks, java.lang.String chunkSize, java.lang.String index, java.io.InputStream inputStream, int executionFlags, int resultFlags, int behaviorFlags, java.lang.String extParam, java.lang.String documentID, StringWrapper msgID, IntWrapper status)
      Create a cube on the IServer based on a file at the specified url, with support to msgID and tableID for EMMA cube.
      java.lang.String ReBuildReport​(java.lang.String sessionID, java.lang.String messageID, int resultFlags, java.lang.String viewSettings, java.lang.String windowSetting, java.lang.String styleXSL, java.lang.String webProperties, int stateID, IntWrapper status)
      Alters the report definition based on a user action.
      java.lang.String ReBuildReportEx​(java.lang.String sessionID, java.lang.String messageID, int executionFlags, int resultFlags, java.lang.String viewSettings, java.lang.String windowSetting, java.lang.String styleXSL, java.lang.String webProperties, int stateID, StringWrapper msgID, IntWrapper status)
      This method submits a report manipulation.
      java.lang.String ReBuildReportEx​(java.lang.String sessionID, java.lang.String messageID, int executionFlags, int resultFlags, java.lang.String viewSettings, java.lang.String windowSetting, java.lang.String extParam, java.lang.String styleXSL, java.lang.String webProperties, int stateID, int requestTimeout, StringWrapper msgID, IntWrapper status)
      This method submits a report manipulation.
      java.lang.String ReBuildReportEx​(java.lang.String sessionID, java.lang.String messageID, int executionFlags, int resultFlags, java.lang.String viewSettings, java.lang.String windowSetting, java.lang.String extParam, java.lang.String styleXSL, java.lang.String webProperties, int stateID, StringWrapper msgID, IntWrapper status)
      This method submits a report manipulation.
      java.lang.String Refresh​(java.lang.String sessionID, java.lang.String messageID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String viewSetting, java.lang.String windowSetting, java.lang.String extParam, java.lang.String styleXSL, java.lang.String webProperties, int stateID, IntWrapper status)
      This method re-executes a report.
      java.lang.String Refresh​(java.lang.String sessionID, java.lang.String messageID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String viewSetting, java.lang.String windowSetting, java.lang.String extParam, java.lang.String styleXSL, java.lang.String webProperties, int stateID, IntWrapper status, IntWrapper jobId)
      This method re-executes a report.
      java.lang.String Refresh​(java.lang.String sessionID, java.lang.String messageID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String viewSetting, java.lang.String windowSetting, java.lang.String extParam, java.lang.String styleXSL, java.lang.String webProperties, int stateID, IntWrapper status, java.util.List<TableAction> tableActions)
      This method re-executes a report.
      java.lang.String Refresh​(java.lang.String sessionID, java.lang.String messageID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String viewSetting, java.lang.String windowSetting, java.lang.String extParam, java.lang.String styleXSL, java.lang.String webProperties, int stateID, IntWrapper status, java.util.List<TableAction> tableActions, IntWrapper jobId)
      This method re-executes a report.
      java.lang.String SaveAs​(java.lang.String sessionID, java.lang.String messageID, java.lang.String folderID, java.lang.String reportName, java.lang.String reportDesc, int viewIndex, int flags, int dispMode, int stateID)
      This method saves a report.
      java.lang.String SaveAs​(java.lang.String sessionID, java.lang.String messageID, java.lang.String folderID, java.lang.String reportName, java.lang.String reportDesc, int viewIndex, int flags, int dispMode, int stateID, StringWrapper msgId)
      This method saves a report.
      java.lang.String SaveAs​(java.lang.String sessionID, java.lang.String messageID, java.lang.String folderID, java.lang.String reportName, java.lang.String reportDesc, int viewIndex, int flags, int dispMode, int stateID, StringWrapper msgId, int requestTimeout)
      This method saves a report.
      java.lang.String SaveDerivedElements​(java.lang.String sessionID, java.lang.String messageID, java.lang.String attId, java.lang.String folderId, java.lang.String name, java.lang.String description, boolean overwrite, IntWrapper status)  
      void SendBinaryData​(java.lang.String sessionID, java.lang.String messageID, int format, IContentConsumer contentConsumer)  
      void SendCubeResultsInBinary​(java.lang.String sessionID, java.lang.String reportID, java.lang.String messageID, int sheetIndex, int resultFlags, int detailFlags, int stateID, java.lang.String extendableParameter, IntWrapper iwStatus, IContentConsumer consumer)
      Obtains the result/data of the cube from back in Binary.
      void SendExecutionResultsInBinary​(java.lang.String sessionID, java.lang.String messageID, int resultFlags, int detailFlags, int stateID, java.lang.String extendableParameter, IntWrapper iwStatus, IContentConsumer consumer)
      Obtains the results/data of the report in binary format.
      java.lang.String SetCubeMapping​(java.lang.String sessionID, java.lang.String msgID, java.lang.String mappingXML)
      Set the row/column to attribute/metric mapping for the specified imported cube
      java.lang.String SetCubeMapping​(java.lang.String sessionID, java.lang.String msgID, java.lang.String mappingXML, java.lang.String cubeRepublishBehavior)
      Set the row/column to attribute/metric mapping for the specified imported cube, with support to cube republishing behavior flag
      java.lang.String SetCubeMapping​(java.lang.String sessionID, java.lang.String msgID, java.lang.String mappingXML, java.lang.String cubeRepublishBehavior, java.lang.String documentID)
      Set the row/column to attribute/metric mapping for the specified imported cube, with support to cube republishing behavior flag
      java.lang.String UploadWallet​(java.lang.String sessionID, java.lang.String messageID, java.lang.String tableID, java.lang.String reportID, java.lang.String fileName, java.lang.String fileType, long fileLength, java.io.InputStream data, int executionFlags, int resultFlags, int behaviorFlags, java.lang.String extParam, java.lang.String documentID, StringWrapper msgID, IntWrapper status, java.lang.String did)
      Create a cube on the IServer based on the wallet file passed in if no did passed in, with support to EMMA msgID and source table ID; Or save wallet file to disk if did is passed in.
      java.lang.String ValidateSourceTableForEmmaCube​(java.lang.String sessionID, java.lang.String messageID, java.lang.String stbXML)
      Validate the source tables for the EMMA cube.

    • Field Detail

      • DEFAULT_Execute_executionFlags

        static final int DEFAULT_Execute_executionFlags
        Default value for the executionFlags parameter of the Execute method
        See Also:
        Constant Field Values

      • DEFAULT_Execute_resultFlags

        static final int DEFAULT_Execute_resultFlags
        Default value for the resultFlags parameter of the Execute method
        See Also:
        Constant Field Values

      • DEFAULT_Execute_promptAnswer

        static final java.lang.String DEFAULT_Execute_promptAnswer
        Default value for the promptAnswer parameter of the Execute method
        See Also:
        Constant Field Values

      • DEFAULT_Execute_viewSettings

        static final java.lang.String DEFAULT_Execute_viewSettings
        Default value for the viewSettings parameter of the Execute method
        See Also:
        Constant Field Values

      • DEFAULT_Execute_windowSetting

        static final java.lang.String DEFAULT_Execute_windowSetting
        Default value for the windowSetting parameter of the Execute method
        See Also:
        Constant Field Values

      • DEFAULT_Execute_styleXSL

        static final java.lang.String DEFAULT_Execute_styleXSL
        Default value for the styleXSL parameter of the Execute method
        See Also:
        Constant Field Values

      • DEFAULT_Execute_webProperties

        static final java.lang.String DEFAULT_Execute_webProperties
        Default value for the webProperties parameter of the Execute method
        See Also:
        Constant Field Values

      • DEFAULT_GetExecutionResults_resultFlags

        static final int DEFAULT_GetExecutionResults_resultFlags
        Default value for the resultFlags parameter of the GetExecutionResults method
        See Also:
        Constant Field Values

      • DEFAULT_GetExecutionResults_windowSetting

        static final java.lang.String DEFAULT_GetExecutionResults_windowSetting
        Default value for the windowSetting parameter of the GetExecutionResults method
        See Also:
        Constant Field Values

      • DEFAULT_GetExecutionResults_styleXSL

        static final java.lang.String DEFAULT_GetExecutionResults_styleXSL
        Default value for the styleXSL parameter of the GetExecutionResults method
        See Also:
        Constant Field Values

      • DEFAULT_GetExecutionResults_stateID

        static final int DEFAULT_GetExecutionResults_stateID
        Default value for the stateID parameter of the GetExecutionResults method
        See Also:
        Constant Field Values

      • DEFAULT_ReBuildReport_resultFlags

        static final int DEFAULT_ReBuildReport_resultFlags
        Default value for the resultFlags parameter of the ReBuildReport method
        See Also:
        Constant Field Values

      • DEFAULT_ReBuildReport_viewSettings

        static final java.lang.String DEFAULT_ReBuildReport_viewSettings
        Default value for the viewSettings parameter of the ReBuildReport method
        See Also:
        Constant Field Values

      • DEFAULT_ReBuildReport_windowSetting

        static final java.lang.String DEFAULT_ReBuildReport_windowSetting
        Default value for the windowSetting parameter of the ReBuildReport method
        See Also:
        Constant Field Values

      • DEFAULT_ReBuildReport_styleXSL

        static final java.lang.String DEFAULT_ReBuildReport_styleXSL
        Default value for the styleXSL parameter of the ReBuildReport method
        See Also:
        Constant Field Values

      • DEFAULT_ReBuildReport_webProperties

        static final java.lang.String DEFAULT_ReBuildReport_webProperties
        Default value for the webProperties parameter of the ReBuildReport method
        See Also:
        Constant Field Values

      • DEFAULT_ReBuildReport_stateID

        static final int DEFAULT_ReBuildReport_stateID
        Default value for the stateID parameter of the ReBuildReport method
        See Also:
        Constant Field Values

      • DEFAULT_AnswerPrompt_executionFlags

        static final int DEFAULT_AnswerPrompt_executionFlags
        Default value for the executionFlags parameter of the AnswerPrompt method
        See Also:
        Constant Field Values

      • DEFAULT_AnswerPrompt_resultFlags

        static final int DEFAULT_AnswerPrompt_resultFlags
        Default value for the resultFlags parameter of the AnswerPrompt method
        See Also:
        Constant Field Values

      • DEFAULT_AnswerPrompt_viewSettings

        static final java.lang.String DEFAULT_AnswerPrompt_viewSettings
        Default value for the viewSettings parameter of the AnswerPrompt method
        See Also:
        Constant Field Values

      • DEFAULT_AnswerPrompt_windowSetting

        static final java.lang.String DEFAULT_AnswerPrompt_windowSetting
        Default value for the windowSetting parameter of the AnswerPrompt method
        See Also:
        Constant Field Values

      • DEFAULT_AnswerPrompt_styleXSL

        static final java.lang.String DEFAULT_AnswerPrompt_styleXSL
        Default value for the styleXSL parameter of the AnswerPrompt method
        See Also:
        Constant Field Values

      • DEFAULT_AnswerPrompt_webProperties

        static final java.lang.String DEFAULT_AnswerPrompt_webProperties
        Default value for the webProperties parameter of the AnswerPrompt method
        See Also:
        Constant Field Values

      • DEFAULT_Drill_viewIndex

        static final int DEFAULT_Drill_viewIndex
        Default value for the viewIndex parameter of the Drill method
        See Also:
        Constant Field Values

      • DEFAULT_Drill_stateID

        static final int DEFAULT_Drill_stateID
        Default value for the stateID parameter of the Drill method
        See Also:
        Constant Field Values

      • DEFAULT_Refresh_executionFlags

        static final int DEFAULT_Refresh_executionFlags
        Default value for the executionFlags parameter of the Refresh method
        See Also:
        Constant Field Values

      • DEFAULT_Refresh_resultFlags

        static final int DEFAULT_Refresh_resultFlags
        Default value for the resultFlags parameter of the Refresh method
        See Also:
        Constant Field Values

      • DEFAULT_Refresh_promptAnswer

        static final java.lang.String DEFAULT_Refresh_promptAnswer
        Default value for the promptAnswer parameter of the Refresh method
        See Also:
        Constant Field Values

      • DEFAULT_Refresh_viewSettings

        static final java.lang.String DEFAULT_Refresh_viewSettings
        Default value for the viewSettings parameter of the Refresh method
        See Also:
        Constant Field Values

      • DEFAULT_Refresh_windowSetting

        static final java.lang.String DEFAULT_Refresh_windowSetting
        Default value for the windowSetting parameter of the Refresh method
        See Also:
        Constant Field Values

      • DEFAULT_Refresh_styleXSL

        static final java.lang.String DEFAULT_Refresh_styleXSL
        Default value for the styleXSL parameter of the Refresh method
        See Also:
        Constant Field Values

      • DEFAULT_Refresh_webProperties

        static final java.lang.String DEFAULT_Refresh_webProperties
        Default value for the webProperties parameter of the Refresh method
        See Also:
        Constant Field Values

      • DEFAULT_Refresh_stateID

        static final int DEFAULT_Refresh_stateID
        Default value for the stateID parameter of the Refresh method
        See Also:
        Constant Field Values

      • DEFAULT_SaveAs_viewIndex

        static final int DEFAULT_SaveAs_viewIndex
        Default value for the viewIndex parameter of the SaveAs method
        See Also:
        Constant Field Values

      • DEFAULT_SaveAs_flags

        static final int DEFAULT_SaveAs_flags
        Default value for the flags parameter of the SaveAs method
        See Also:
        Constant Field Values

      • DEFAULT_SaveAs_dispMode

        static final int DEFAULT_SaveAs_dispMode
        Default value for the dispMode parameter of the SaveAs method
        See Also:
        Constant Field Values

      • DEFAULT_SaveAs_stateID

        static final int DEFAULT_SaveAs_stateID
        Default value for the stateID parameter of the SaveAs method
        See Also:
        Constant Field Values

      • DEFAULT_ReBuildReportEx_executionFlags

        static final int DEFAULT_ReBuildReportEx_executionFlags
        Default value for the executionFlags parameter of the ReBuildReportEx method
        See Also:
        Constant Field Values

      • DEFAULT_ReBuildReportEx_resultFlags

        static final int DEFAULT_ReBuildReportEx_resultFlags
        Default value for the resultFlags parameter of the ReBuildReportEx method
        See Also:
        Constant Field Values

      • DEFAULT_ReBuildReportEx_viewSettings

        static final java.lang.String DEFAULT_ReBuildReportEx_viewSettings
        Default value for the viewSettings parameter of the ReBuildReportEx method
        See Also:
        Constant Field Values

      • DEFAULT_ReBuildReportEx_windowSetting

        static final java.lang.String DEFAULT_ReBuildReportEx_windowSetting
        Default value for the windowSetting parameter of the ReBuildReportEx method
        See Also:
        Constant Field Values

      • DEFAULT_ReBuildReportEx_styleXSL

        static final java.lang.String DEFAULT_ReBuildReportEx_styleXSL
        Default value for the styleXSL parameter of the ReBuildReportEx method
        See Also:
        Constant Field Values

      • DEFAULT_ReBuildReportEx_webProperties

        static final java.lang.String DEFAULT_ReBuildReportEx_webProperties
        Default value for the webProperties parameter of the ReBuildReportEx method
        See Also:
        Constant Field Values

      • DEFAULT_ReBuildReportEx_stateID

        static final int DEFAULT_ReBuildReportEx_stateID
        Default value for the stateID parameter of the ReBuildReportEx method
        See Also:
        Constant Field Values

    • Method Detail

      • AnswerPrompt

        java.lang.String AnswerPrompt​(java.lang.String sessionID,
                              java.lang.String messageID,
                              java.lang.String promptAnswer,
                              int executionFlags,
                              int resultFlags,
                              java.lang.String viewSettings,
                              java.lang.String windowSetting,
                              java.lang.String styleXSL,
                              java.lang.String webProperties,
                              IntWrapper status)
                       throws MSTRWebAPIException
        This method answers a prompt and lets the report execution continue.

        This function applies the promptAnswer to the report prompt and continue the report execution or re-submit the report answer after the report prompt has been answered. Caller should call check the status to decide if GetExecutionResults needs to be called to retrieve the results.

        There might be more prompts to answer after the PromptAnswer is applied to the report due to the user selection containing prompt(s) or the user didn?t answer all the prompts. When calling GetExecutionResults, the status DssXmlStatusPromptXML indicates that scenario and the new promptXML is returned in executionResults.

        See remarks under Execute for more on report execution.

        Parameters:
        sessionID - A valid Session ID.
        messageID - Message ID corresponding to the report to be answered.
        promptAnswer - Answer to prompt(s) for the report execution.
        executionFlags - Options for the execution of the report. Value must be from EnumDSSXMLExecutionFlags. [Default=DssXmlExecutionUseCache + DssXmlExecutionUpdateCache]
        resultFlags - Options for getting the report results. Value must be from EnumDSSXMLResultFlags. [Default=DssXmlResultPreserve]
        viewSettings - XML (containing view index, deltaXML, grid/graph properties) for setting the view of the report. [Default=""]
        windowSetting - XML (starting row, starting column, max row, max column) for a display window. [Default=""]
        styleXSL - XSL for the report style. [Default=""]
        webProperties - Properties associated with this report. [Default=""]
        status - Output Parameter - Current status of execution - comes from EnumDSSXMLStatus.
        Returns:
        Empty if there is no cache for this report or the resultFlags indicates "status only"; in this case, the user needs to call GetExecutionResults to retrieve the results. Report execution results if a cache is hit and "status only" is not indicated by the resultFlags.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • Drill

        void Drill​(java.lang.String sessionID,
           java.lang.String messageID,
           java.lang.String drillTransformation,
           int viewIndex,
           int stateID,
           StringWrapper drillMsgID)
    throws MSTRWebAPIException
        This method performs drill operations on a report.

        This function performs a drill action defined by the drillTransformation parameter. The drillTransformation is with respect to the report results that the user is seeing right now. These could be the end results of a few report manipulations such as pivot, sort and page-by on the original Report Instance. These report manipulations are recorded in the Inbox and the drilling is done on a Report Instance that has all these transformations applied to it. The input messageID indicates the report you want to drill on. A new message needs to be created for the drill result and the ID for this new message will be returned. Caller can specify an optional report view (through the viewIndex parameter) for the drill results. This function will never return a result directly. GetExecutionResults has to be called with the new message ID, to retrieve the drill results.

        Refer to the remarks of IDSSXMLReportServer.GetExecutionResults for details of the stateID parameter. The drill will be applied on the report state identified by the stateID when it is present. By default, the drill will be on the final state of the report.

        Parameters:
        sessionID - A valid Session ID.
        messageID - Message ID corresponding to the report to be drilled.
        drillTransformation - XML that defines the drill action
        viewIndex - Indicate which view of the report is being requested to present. [Default=-1]
        stateID - An ID to identify the report manipulation state. [Default=-1]
        drillMsgID - Return Parameter - The message ID resulting from the drill operation.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • Execute

        java.lang.String Execute​(java.lang.String sessionID,
                         java.lang.String reportID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String viewSetting,
                         java.lang.String windowSetting,
                         java.lang.String styleXSL,
                         java.lang.String webProperties,
                         StringWrapper msgID,
                         IntWrapper status)
                  throws MSTRWebAPIException
        This method executes a report by report ID.

        ReportID is the ID of the report to be executed.

        ExecutionFlag is an integer that is a bitwise "or" using values from EnumDSSXMLExecutionFlags. The default value is DssXmlExecutionUseCache + DssXmlExecutionUpdateCache (refer to the flags section for details). To execute a datamart report, DssXmlExecutionGenerateDatamart should be included in the execution flags. (To get the resultant datamart table name, include DssXmlResultDatamartTableName in the result flags described below.)

        The application can choose to use a different view, sort, pivot, page by, set grid/graph properties by specifying the optional viewSettings parameter. This parameter is in XML format which contains a view index, a deltaXML for sorting, pivoting and page by, a grid properties (grid style) and a graph properties (graph style and size).

        If the report execution hits a cache, a report result will be returned in the ExecutionResults. The resultFlags is used to customize the execution results. If an error happens while the report is being executed, an error message will be returned by throwing a MSTRWebAPIException. Otherwise an inbox message ID will be returned in the messageID output parameter.

        With promptAnswer , the caller can provide an answer to a prompt in the report before executing it.

        The status of the function call indicates the execution status. See the flags section for details.

        In the case a report result is returned, windowSetting allows an application to specify the starting row, starting column, maximum row and maximum column of the returning results. The total row/column count can be found in the result XML. An application can start with 0 starting row/column and its prefered page size as the max row/column count, and move the page window using the total row/column count in the first page of returned result XML. If the optional styleXSL is set, XML API will apply the XSL on the report result XML and return the resultant HTML.

        Any settings for the report (report mode, drill, pivot, page by, display window and grid/graph properties etc.) will be persisted in the inbox. A report retrieved from the inbox will have exactly the same look and feel as the first time it is executed.

        An API user can associate some properties with the report by providing a webProperties parameters. These properties will be saved in Metadata when the report is saved. They will also be in the report result XML. webProperties is in XML format.

        Parameters:
        sessionID - A valid Session ID
        reportID - ID of the report to run.
        executionFlags - Flags specify different options for the execution. Value must be a bitwise "or" (addition) of values from EnumDSSXMLExecutionFlags. [Default=DssXmlExecutionUseCache + DssXmlExecutionUpdateCache]
        resultFlags - Tells the server how to present the results. This value must be a bitwise "or" (addition) of values from EnumDSSXMLResultFlags. [Default=0]
        promptAnswer - Answer to prompt, if any, for the report execution. [Default=""]
        viewSetting - XML (containing view index, deltaXML, grid/graph properties) for setting the view of the report. [Default=""]
        windowSetting - XML (starting row, starting column, max row, max column) for a display window. [Default=""]
        styleXSL - XSL for the report style. [Default=""]
        webProperties - Properties associated with this report. [Default=""]
        msgID - Output ParameterMessage ID for the report.
        status - Output ParameterStatus of the report. Will correspond to one of the values in EnumDSSXMLStatus.
        Returns:
        Resultant report XML, if report is ready, or resultant prompt question XML, if the report has prompts. Empty String if none of those conditions are true.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • Execute

        java.lang.String Execute​(java.lang.String sessionID,
                         java.lang.String reportID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String viewSetting,
                         java.lang.String windowSetting,
                         java.lang.String extParams,
                         java.lang.String styleXSL,
                         java.lang.String webProperties,
                         StringWrapper msgID,
                         IntWrapper status)
                  throws MSTRWebAPIException
        This method executes a report by report ID.

        ReportID is the ID of the report to be executed.

        ExecutionFlag is an integer that is a bitwise "or" using values from EnumDSSXMLExecutionFlags. The default value is DssXmlExecutionUseCache + DssXmlExecutionUpdateCache (refer to the flags section for details). To execute a datamart report, DssXmlExecutionGenerateDatamart should be included in the execution flags. (To get the resultant datamart table name, include DssXmlResultDatamartTableName in the result flags described below.)

        The application can choose to use a different view, sort, pivot, page by, set grid/graph properties by specifying the optional viewSettings parameter. This parameter is in XML format which contains a view index, a deltaXML for sorting, pivoting and page by, a grid properties (grid style) and a graph properties (graph style and size).

        If the report execution hits a cache, a report result will be returned in the ExecutionResults. The resultFlags is used to customize the execution results. If an error happens while the report is being executed, an error message will be returned by throwing a MSTRWebAPIException. Otherwise an inbox message ID will be returned in the messageID output parameter.

        With promptAnswer , the caller can provide an answer to a prompt in the report before executing it.

        The status of the function call indicates the execution status. See the flags section for details.

        In the case a report result is returned, windowSetting allows an application to specify the starting row, starting column, maximum row and maximum column of the returning results. The total row/column count can be found in the result XML. An application can start with 0 starting row/column and its prefered page size as the max row/column count, and move the page window using the total row/column count in the first page of returned result XML. If the optional styleXSL is set, XML API will apply the XSL on the report result XML and return the resultant HTML.

        Any settings for the report (report mode, drill, pivot, page by, display window and grid/graph properties etc.) will be persisted in the inbox. A report retrieved from the inbox will have exactly the same look and feel as the first time it is executed.

        An API user can associate some properties with the report by providing a webProperties parameters. These properties will be saved in Metadata when the report is saved. They will also be in the report result XML. webProperties is in XML format.

        Parameters:
        sessionID - A valid Session ID
        reportID - ID of the report to run.
        executionFlags - Flags specify different options for the execution. Value must be a bitwise "or" (addition) of values from EnumDSSXMLExecutionFlags. [Default=DssXmlExecutionUseCache + DssXmlExecutionUpdateCache]
        resultFlags - Tells the server how to present the results. This value must be a bitwise "or" (addition) of values from EnumDSSXMLResultFlags. [Default=0]
        promptAnswer - Answer to prompt, if any, for the report execution. [Default=""]
        viewSetting - XML (containing view index, deltaXML, grid/graph properties) for setting the view of the report. [Default=""]
        windowSetting - XML (starting row, starting column, max row, max column) for a display window. [Default=""]
        extParams - indicates any applicable extendable parameters
        styleXSL - XSL for the report style. [Default=""]
        webProperties - Properties associated with this report. [Default=""]
        msgID - Output ParameterMessage ID for the report.
        status - Output ParameterStatus of the report. Will correspond to one of the values in EnumDSSXMLStatus.
        Returns:
        Resultant report XML, if report is ready, or resultant prompt question XML, if the report has prompts. Empty String if none of those conditions are true.
        Throws:
        MSTRWebAPIException - Signals an error condition.
        Since:
        MicroStrategy Web 8.0.0

      • Execute

        java.lang.String Execute​(java.lang.String sessionID,
                         java.lang.String reportID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String viewSetting,
                         java.lang.String windowSetting,
                         java.lang.String extParams,
                         int requestTimeout,
                         java.lang.String styleXSL,
                         java.lang.String webProperties,
                         StringWrapper msgID,
                         IntWrapper status)
                  throws MSTRWebAPIException
        This method executes a report by report ID.

        ReportID is the ID of the report to be executed.

        ExecutionFlag is an integer that is a bitwise "or" using values from EnumDSSXMLExecutionFlags. The default value is DssXmlExecutionUseCache + DssXmlExecutionUpdateCache (refer to the flags section for details). To execute a datamart report, DssXmlExecutionGenerateDatamart should be included in the execution flags. (To get the resultant datamart table name, include DssXmlResultDatamartTableName in the result flags described below.)

        The application can choose to use a different view, sort, pivot, page by, set grid/graph properties by specifying the optional viewSettings parameter. This parameter is in XML format which contains a view index, a deltaXML for sorting, pivoting and page by, a grid properties (grid style) and a graph properties (graph style and size).

        If the report execution hits a cache, a report result will be returned in the ExecutionResults. The resultFlags is used to customize the execution results. If an error happens while the report is being executed, an error message will be returned by throwing a MSTRWebAPIException. Otherwise an inbox message ID will be returned in the messageID output parameter.

        With promptAnswer , the caller can provide an answer to a prompt in the report before executing it.

        The status of the function call indicates the execution status. See the flags section for details.

        In the case a report result is returned, windowSetting allows an application to specify the starting row, starting column, maximum row and maximum column of the returning results. The total row/column count can be found in the result XML. An application can start with 0 starting row/column and its prefered page size as the max row/column count, and move the page window using the total row/column count in the first page of returned result XML. If the optional styleXSL is set, XML API will apply the XSL on the report result XML and return the resultant HTML.

        Any settings for the report (report mode, drill, pivot, page by, display window and grid/graph properties etc.) will be persisted in the inbox. A report retrieved from the inbox will have exactly the same look and feel as the first time it is executed.

        An API user can associate some properties with the report by providing a webProperties parameters. These properties will be saved in Metadata when the report is saved. They will also be in the report result XML. webProperties is in XML format.

        Parameters:
        sessionID - A valid Session ID
        reportID - ID of the report to run.
        executionFlags - Flags specify different options for the execution. Value must be a bitwise "or" (addition) of values from EnumDSSXMLExecutionFlags. [Default=DssXmlExecutionUseCache + DssXmlExecutionUpdateCache]
        resultFlags - Tells the server how to present the results. This value must be a bitwise "or" (addition) of values from EnumDSSXMLResultFlags. [Default=0]
        promptAnswer - Answer to prompt, if any, for the report execution. [Default=""]
        viewSetting - XML (containing view index, deltaXML, grid/graph properties) for setting the view of the report. [Default=""]
        windowSetting - XML (starting row, starting column, max row, max column) for a display window. [Default=""]
        extParams - indicates any applicable extendable parameters
        requestTimeout - Request timeout value. It is used to override the default session request timeout value for the saving job. By default it's -1.
        styleXSL - XSL for the report style. [Default=""]
        webProperties - Properties associated with this report. [Default=""]
        msgID - Output ParameterMessage ID for the report.
        status - Output ParameterStatus of the report. Will correspond to one of the values in EnumDSSXMLStatus.
        Returns:
        Resultant report XML, if report is ready, or resultant prompt question XML, if the report has prompts. Empty String if none of those conditions are true.
        Throws:
        MSTRWebAPIException - Signals an error condition.
        Since:
        MicroStrategy Web 8.0.0

      • Execute

        java.lang.String Execute​(java.lang.String sessionID,
                         java.lang.String reportID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String viewSetting,
                         java.lang.String windowSetting,
                         java.lang.String extParams,
                         int requestTimeout,
                         java.lang.String styleXSL,
                         java.lang.String webProperties,
                         StringWrapper msgID,
                         IntWrapper status,
                         java.lang.String subscriptionID)
                  throws MSTRWebAPIException
        This method executes a report by report ID.

        ReportID is the ID of the report to be executed.

        ExecutionFlag is an integer that is a bitwise "or" using values from EnumDSSXMLExecutionFlags. The default value is DssXmlExecutionUseCache + DssXmlExecutionUpdateCache (refer to the flags section for details). To execute a datamart report, DssXmlExecutionGenerateDatamart should be included in the execution flags. (To get the resultant datamart table name, include DssXmlResultDatamartTableName in the result flags described below.)

        The application can choose to use a different view, sort, pivot, page by, set grid/graph properties by specifying the optional viewSettings parameter. This parameter is in XML format which contains a view index, a deltaXML for sorting, pivoting and page by, a grid properties (grid style) and a graph properties (graph style and size).

        If the report execution hits a cache, a report result will be returned in the ExecutionResults. The resultFlags is used to customize the execution results. If an error happens while the report is being executed, an error message will be returned by throwing a MSTRWebAPIException. Otherwise an inbox message ID will be returned in the messageID output parameter.

        With promptAnswer , the caller can provide an answer to a prompt in the report before executing it.

        The status of the function call indicates the execution status. See the flags section for details.

        In the case a report result is returned, windowSetting allows an application to specify the starting row, starting column, maximum row and maximum column of the returning results. The total row/column count can be found in the result XML. An application can start with 0 starting row/column and its prefered page size as the max row/column count, and move the page window using the total row/column count in the first page of returned result XML. If the optional styleXSL is set, XML API will apply the XSL on the report result XML and return the resultant HTML.

        Any settings for the report (report mode, drill, pivot, page by, display window and grid/graph properties etc.) will be persisted in the inbox. A report retrieved from the inbox will have exactly the same look and feel as the first time it is executed.

        An API user can associate some properties with the report by providing a webProperties parameters. These properties will be saved in Metadata when the report is saved. They will also be in the report result XML. webProperties is in XML format.

        Parameters:
        sessionID - A valid Session ID
        reportID - ID of the report to run.
        executionFlags - Flags specify different options for the execution. Value must be a bitwise "or" (addition) of values from EnumDSSXMLExecutionFlags. [Default=DssXmlExecutionUseCache + DssXmlExecutionUpdateCache]
        resultFlags - Tells the server how to present the results. This value must be a bitwise "or" (addition) of values from EnumDSSXMLResultFlags. [Default=0]
        promptAnswer - Answer to prompt, if any, for the report execution. [Default=""]
        viewSetting - XML (containing view index, deltaXML, grid/graph properties) for setting the view of the report. [Default=""]
        windowSetting - XML (starting row, starting column, max row, max column) for a display window. [Default=""]
        extParams - indicates any applicable extendable parameters
        requestTimeout - Request timeout value. It is used to override the default session request timeout value for the saving job. By default it's -1.
        styleXSL - XSL for the report style. [Default=""]
        webProperties - Properties associated with this report. [Default=""]
        msgID - Output ParameterMessage ID for the report.
        status - Output ParameterStatus of the report. Will correspond to one of the values in EnumDSSXMLStatus.
        subscriptionID - ID of subscription if we run the report from subscriptions.
        Returns:
        Resultant report XML, if report is ready, or resultant prompt question XML, if the report has prompts. Empty String if none of those conditions are true.
        Throws:
        MSTRWebAPIException - Signals an error condition.
        Since:
        MicroStrategy Web 8.0.0

      • Execute

        java.lang.String Execute​(ReportExecuteParams reportExecuteParams,
                         StringWrapper msgID,
                         IntWrapper status)
                  throws MSTRWebAPIException
        This method executes a report by report ID.

        ReportID is the ID of the report to be executed.

        ExecutionFlag is an integer that is a bitwise "or" using values from EnumDSSXMLExecutionFlags. The default value is DssXmlExecutionUseCache + DssXmlExecutionUpdateCache (refer to the flags section for details). To execute a datamart report, DssXmlExecutionGenerateDatamart should be included in the execution flags. (To get the resultant datamart table name, include DssXmlResultDatamartTableName in the result flags described below.)

        The application can choose to use a different view, sort, pivot, page by, set grid/graph properties by specifying the optional viewSettings parameter. This parameter is in XML format which contains a view index, a deltaXML for sorting, pivoting and page by, a grid properties (grid style) and a graph properties (graph style and size).

        If the report execution hits a cache, a report result will be returned in the ExecutionResults. The resultFlags is used to customize the execution results. If an error happens while the report is being executed, an error message will be returned by throwing a MSTRWebAPIException. Otherwise an inbox message ID will be returned in the messageID output parameter.

        With promptAnswer , the caller can provide an answer to a prompt in the report before executing it.

        The status of the function call indicates the execution status. See the flags section for details.

        In the case a report result is returned, windowSetting allows an application to specify the starting row, starting column, maximum row and maximum column of the returning results. The total row/column count can be found in the result XML. An application can start with 0 starting row/column and its prefered page size as the max row/column count, and move the page window using the total row/column count in the first page of returned result XML. If the optional styleXSL is set, XML API will apply the XSL on the report result XML and return the resultant HTML.

        Any settings for the report (report mode, drill, pivot, page by, display window and grid/graph properties etc.) will be persisted in the inbox. A report retrieved from the inbox will have exactly the same look and feel as the first time it is executed.

        An API user can associate some properties with the report by providing a webProperties parameters. These properties will be saved in Metadata when the report is saved. They will also be in the report result XML. webProperties is in XML format.

        Parameters:
        reportExecuteParams - The report execution params. See the details in ReportExecuteParams.
        msgID - Output ParameterMessage ID for the report.
        status - Output ParameterStatus of the report. Will correspond to one of the values in EnumDSSXMLStatus.
        Returns:
        Resultant report XML, if report is ready, or resultant prompt question XML, if the report has prompts. Empty String if none of those conditions are true.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • GetExecutionResults

        java.lang.String GetExecutionResults​(java.lang.String sessionID,
                                     java.lang.String messageID,
                                     int resultFlags,
                                     java.lang.String windowSetting,
                                     java.lang.String styleXSL,
                                     int stateID,
                                     IntWrapper status)
                              throws MSTRWebAPIException
        This method retrieves the results of report execution.

        This method is used to retrieve report execution result or prompt question (if the report contains a prompt). This method needs to be called when any executions methods returned with a messageID only (status = EnumDSSXMLResultFlags.DssXmlResultMsgID). Usually this method is in a loop. The termination condition of the loop would be status = DssXmlStatusResult, status = DssXmlStatusPromptXML or status = DssXmlStatusErrMsgXML. You should put a delay in the loop to prevent the server being pulled too frequently.

        Report settings (report mode, display window) will not be persisted. That means, if you use GetExecutionResults to change a report mode from grid to graph. Retrieving the report from the inbox, you will still get a report in grid mode. To persist a report setting, use either Execute or ReBuildReport. Report setting in GetExecutionResults will overwrite the same settings in Execute and ReBuildReport. To keep the original settings specified in Execute or ReBuildReport, do not specify the settings when calling GetExecutionResults.

        A report can be manipulated multiple times (pivot twice and then sort for example). A Web user can also use the back button of a browser to return to any of the report state. The stateID parameter is used to identify each state. The original report has stateID = 0. Subsequent report manipulation will increment the stateID by one.

        This method takes a stateID as an optional parameter. Using the default parameter for this argument will cause the report with the most recent state ID to be returned.

        Any stateID that is higher than the highest stateID of a report will result in an error.

        Parameters:
        sessionID - A valid Session ID
        messageID - The ID of the job/message to retrieve.
        resultFlags - EnumDSSXMLResultFlags - Specifies the options to apply to getting the report result. [Default=DssXmlResultPreserve]
        windowSetting - XML for a display window. [Default=""]
        styleXSL - Optional XSL to apply to the report XML to generate HTML. [Default=""]
        stateID - ID that identifies the report manipulation state. [Default=-1]
        status - Output Parameter - Status of the report execution - value comes from EnumDSSXMLStatus.
        Returns:
        String representing the XML returned for the report, if it is ready. It could also contain prompt question XML, if the report is waiting for a prompt to be answered; Null if result is not ready; an error message if an error happened.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • GetPromptAnswer

        java.lang.String GetPromptAnswer​(java.lang.String sessionID,
                                 java.lang.String messageID)
                          throws MSTRWebAPIException
        This method retrieves a prompt answer. If the report identified by the given message ID contains no prompt or the prompt has not been answered, this method will return an empty string. Otherwise, the latest prompt answered will be returned.
        Parameters:
        sessionID - A valid Session ID
        messageID - The message ID of the report instance.
        Returns:
        XML representing the prompt answer.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • GetPromptAnswerEx

        java.lang.String GetPromptAnswerEx​(java.lang.String sessionID,
                                   java.lang.String messageID,
                                   java.lang.String extendableParameter)
                            throws MSTRWebAPIException
        This method retrieves a prompt answer. If the report identified by the given message ID contains no prompt or the prompt has not been answered, this method will return an empty string. Otherwise, the latest prompt answered will be returned.
        Parameters:
        sessionID - A valid Session ID
        messageID - The message ID of the report instance.
        extendableParameter - The extendable parameter used for the call.
        Returns:
        XML representing the prompt answer.
        Throws:
        MSTRWebAPIException - Signals an error condition.
        Since:
        MicroStrategy Web 8.0.2

      • HasPromptAnswer

        boolean HasPromptAnswer​(java.lang.String sessionID,
                        java.lang.String messageID,
                        StringWrapper promptAnswer)
                 throws MSTRWebAPIException
        Returns whether the report(identified by the given message ID) has prompt answers and retrieves the prompt answer for the given Message ID, if any.

        If the report identified by the given message ID contains no prompt or if the prompt has not been answered, this method will return false and will also return return an null string inside the prompt answer. Otherwise, the latest prompt answered will be returned.

        Parameters:
        sessionID - A valid Session ID.
        messageID - A valid message/job ID.
        promptAnswer - The prompt answer will be returned in this variable.
        Returns:
        boolean indicating whether the report is prompted or not. XML corresponding to the prompt answer as a function argument.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • HasPromptAnswerEx

        boolean HasPromptAnswerEx​(java.lang.String sessionID,
                          java.lang.String messageID,
                          StringWrapper promptAnswer,
                          java.lang.String extendableParameter)
                   throws MSTRWebAPIException
        Returns whether the report(identified by the given message ID) has prompt answers and retrieves the prompt answer for the given Message ID, if any.

        If the report identified by the given message ID contains no prompt or if the prompt has not been answered, this method will return false and will also return return an null string inside the prompt answer. Otherwise, the latest prompt answered will be returned.

        Parameters:
        sessionID - A valid Session ID.
        messageID - A valid message/job ID.
        promptAnswer - The prompt answer will be returned in this variable.
        extendableParameter - The extendable parameter used for the call.
        Returns:
        boolean indicating whether the report is prompted or not. XML corresponding to the prompt answer as a function argument.
        Throws:
        MSTRWebAPIException - Signals an error condition.
        Since:
        MicroStrategy Web 8.0.2

      • ReBuildReport

        java.lang.String ReBuildReport​(java.lang.String sessionID,
                               java.lang.String messageID,
                               int resultFlags,
                               java.lang.String viewSettings,
                               java.lang.String windowSetting,
                               java.lang.String styleXSL,
                               java.lang.String webProperties,
                               int stateID,
                               IntWrapper status)
                        throws MSTRWebAPIException
        Alters the report definition based on a user action. These settings include:
        • Report mode (through resultFlags)
        • Display window (though windowSetting)
        • Pivot, sort or page-by a report (through the deltaXML in the viewSettings)
        • Grid properties (grid style) (through the gridProperties in the viewSettings)
        • Graph properties (graph style/size) (through the graphProperties in the viewSettings)

        Caller should check the status to decide if result is returned immediately, GetExecutionResults needs to be called to get the result.

        See documentation for Execute() for more on report execution.

        Parameters:
        sessionID - A valid Session ID.
        messageID - Message ID corresponding to the report to be rebuilt.
        resultFlags - Options relating to how to get report result - value must be from EnumDSSXMLResultFlags. [Default=DssXmlResultPreserve]
        viewSettings - XML (containing view index, deltaXML, grid/graph properties) for setting the view of the report. [Default=""]
        windowSetting - XML (starting row, starting column, max row, max column) for a display window. [Default=""]
        styleXSL - Optional XSL that will be applied to report XML to generate HTML. [Default=""]
        webProperties - Properties associated with this report. [Default=""]
        stateID - An ID to identify the report manipulation state. [Default=-1]
        status - com.microstrategy.webapi.IntWrapper Output Parameter - returns a value of EnumDSSXMLStatus - tells status of request.
        Returns:
        java.lang.String The report XML, if the execution is complete, or prompt XML if the report is waiting on a prompt answer.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • Refresh

        java.lang.String Refresh​(java.lang.String sessionID,
                         java.lang.String messageID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String viewSetting,
                         java.lang.String windowSetting,
                         java.lang.String extParam,
                         java.lang.String styleXSL,
                         java.lang.String webProperties,
                         int stateID,
                         IntWrapper status,
                         java.util.List<TableAction> tableActions)
                  throws MSTRWebAPIException
        This method re-executes a report.

        If there is a prompt in the report, the user will be prompted irrespective of the value of the DeclinePrompts flag on the report definition on which the current report is based. But if the user provides a promptanswer, that will be used. If the executionflags have DssXmlExecutionDefaultPrompt set, then the default prompt answer will be used. If the API user wants to be reprompted, they can still get that functionality by not setting this flag.

        If after the prompt is resolved, we hit a cache, the cache will be used. So refresh does not necessarily mean that we are going to run against the warehouse.

        Refer to the remarks of IDSSXMLReportServer.Execute for details of the stateID parameter. When this optional parameter is present, this method will refresh the report state identified by the stateID. When omitted, the final state of the report will be refreshed.

        Parameters:
        sessionID - A valid Session ID.
        messageID - Message ID corresponding to the report to be refreshed.
        executionFlags - Specifies different options used in the execution of the report - based on EnumDSSXMLExecutionFlags. [Default=DssXmlExecutionUseCache + DssXmlExecutionUpdateCache]
        resultFlags - int Specifies how to present the report. Value must come from EnumDSSXMLResultFlags. [Default=DssXmlResultPreserve]
        promptAnswer - Answer(s) to prompt(s), if any, in the report execution. [Default=""]
        viewSetting - XML (containing view index, deltaXML, grid/graph properties) for setting the view of the report. [Default=""]
        windowSetting - XML (starting row, starting column, max row, max column) for a display window. [Default=""]
        extParams - indicates any applicable extendable parameters
        styleXSL - Optional XSL to be applied to XML to generate HTML. [Default=""]
        webProperties - Properties associated with this report. [Default=""]
        stateID - longAn ID to identify the report manipulation state. [Default=-1]
        status - Output Parameter - returns a value of EnumDSSXMLStatus - returns status of request.
        Returns:
        If the report is finished execution, then the report XML will be returned. Otherwise, nothing will be returned.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • Refresh

        java.lang.String Refresh​(java.lang.String sessionID,
                         java.lang.String messageID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String viewSetting,
                         java.lang.String windowSetting,
                         java.lang.String extParam,
                         java.lang.String styleXSL,
                         java.lang.String webProperties,
                         int stateID,
                         IntWrapper status,
                         java.util.List<TableAction> tableActions,
                         IntWrapper jobId)
                  throws MSTRWebAPIException
        This method re-executes a report.

        If there is a prompt in the report, the user will be prompted irrespective of the value of the DeclinePrompts flag on the report definition on which the current report is based. But if the user provides a promptanswer, that will be used. If the executionflags have DssXmlExecutionDefaultPrompt set, then the default prompt answer will be used. If the API user wants to be reprompted, they can still get that functionality by not setting this flag.

        If after the prompt is resolved, we hit a cache, the cache will be used. So refresh does not necessarily mean that we are going to run against the warehouse.

        Refer to the remarks of IDSSXMLReportServer.Execute for details of the stateID parameter. When this optional parameter is present, this method will refresh the report state identified by the stateID. When omitted, the final state of the report will be refreshed.

        Parameters:
        sessionID - A valid Session ID.
        messageID - Message ID corresponding to the report to be refreshed.
        executionFlags - Specifies different options used in the execution of the report - based on EnumDSSXMLExecutionFlags. [Default=DssXmlExecutionUseCache + DssXmlExecutionUpdateCache]
        resultFlags - int Specifies how to present the report. Value must come from EnumDSSXMLResultFlags. [Default=DssXmlResultPreserve]
        promptAnswer - Answer(s) to prompt(s), if any, in the report execution. [Default=""]
        viewSetting - XML (containing view index, deltaXML, grid/graph properties) for setting the view of the report. [Default=""]
        windowSetting - XML (starting row, starting column, max row, max column) for a display window. [Default=""]
        extParam - indicates any applicable extendable parameters
        styleXSL - Optional XSL to be applied to XML to generate HTML. [Default=""]
        webProperties - Properties associated with this report. [Default=""]
        stateID - longAn ID to identify the report manipulation state. [Default=-1]
        status - Output Parameter - returns a value of EnumDSSXMLStatus - returns status of request.
        jobId - Output Parameter - return the jobid
        Returns:
        If the report is finished execution, then the report XML will be returned. Otherwise, nothing will be returned.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • Refresh

        java.lang.String Refresh​(java.lang.String sessionID,
                         java.lang.String messageID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String viewSetting,
                         java.lang.String windowSetting,
                         java.lang.String extParam,
                         java.lang.String styleXSL,
                         java.lang.String webProperties,
                         int stateID,
                         IntWrapper status)
                  throws MSTRWebAPIException
        This method re-executes a report.

        If there is a prompt in the report, the user will be prompted irrespective of the value of the DeclinePrompts flag on the report definition on which the current report is based. But if the user provides a promptanswer, that will be used. If the executionflags have DssXmlExecutionDefaultPrompt set, then the default prompt answer will be used. If the API user wants to be reprompted, they can still get that functionality by not setting this flag.

        If after the prompt is resolved, we hit a cache, the cache will be used. So refresh does not necessarily mean that we are going to run against the warehouse.

        Refer to the remarks of IDSSXMLReportServer.Execute for details of the stateID parameter. When this optional parameter is present, this method will refresh the report state identified by the stateID. When omitted, the final state of the report will be refreshed.

        Parameters:
        sessionID - A valid Session ID.
        messageID - Message ID corresponding to the report to be refreshed.
        executionFlags - Specifies different options used in the execution of the report - based on EnumDSSXMLExecutionFlags. [Default=DssXmlExecutionUseCache + DssXmlExecutionUpdateCache]
        resultFlags - int Specifies how to present the report. Value must come from EnumDSSXMLResultFlags. [Default=DssXmlResultPreserve]
        promptAnswer - Answer(s) to prompt(s), if any, in the report execution. [Default=""]
        viewSetting - XML (containing view index, deltaXML, grid/graph properties) for setting the view of the report. [Default=""]
        windowSetting - XML (starting row, starting column, max row, max column) for a display window. [Default=""]
        extParams - indicates any applicable extendable parameters
        styleXSL - Optional XSL to be applied to XML to generate HTML. [Default=""]
        webProperties - Properties associated with this report. [Default=""]
        stateID - longAn ID to identify the report manipulation state. [Default=-1]
        status - Output Parameter - returns a value of EnumDSSXMLStatus - returns status of request.
        Returns:
        If the report is finished execution, then the report XML will be returned. Otherwise, nothing will be returned.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • Refresh

        java.lang.String Refresh​(java.lang.String sessionID,
                         java.lang.String messageID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String viewSetting,
                         java.lang.String windowSetting,
                         java.lang.String extParam,
                         java.lang.String styleXSL,
                         java.lang.String webProperties,
                         int stateID,
                         IntWrapper status,
                         IntWrapper jobId)
                  throws MSTRWebAPIException
        This method re-executes a report.

        If there is a prompt in the report, the user will be prompted irrespective of the value of the DeclinePrompts flag on the report definition on which the current report is based. But if the user provides a promptanswer, that will be used. If the executionflags have DssXmlExecutionDefaultPrompt set, then the default prompt answer will be used. If the API user wants to be reprompted, they can still get that functionality by not setting this flag.

        If after the prompt is resolved, we hit a cache, the cache will be used. So refresh does not necessarily mean that we are going to run against the warehouse.

        Refer to the remarks of IDSSXMLReportServer.Execute for details of the stateID parameter. When this optional parameter is present, this method will refresh the report state identified by the stateID. When omitted, the final state of the report will be refreshed.

        Parameters:
        sessionID - A valid Session ID.
        messageID - Message ID corresponding to the report to be refreshed.
        executionFlags - Specifies different options used in the execution of the report - based on EnumDSSXMLExecutionFlags. [Default=DssXmlExecutionUseCache + DssXmlExecutionUpdateCache]
        resultFlags - int Specifies how to present the report. Value must come from EnumDSSXMLResultFlags. [Default=DssXmlResultPreserve]
        promptAnswer - Answer(s) to prompt(s), if any, in the report execution. [Default=""]
        viewSetting - XML (containing view index, deltaXML, grid/graph properties) for setting the view of the report. [Default=""]
        windowSetting - XML (starting row, starting column, max row, max column) for a display window. [Default=""]
        extParam - indicates any applicable extendable parameters
        styleXSL - Optional XSL to be applied to XML to generate HTML. [Default=""]
        webProperties - Properties associated with this report. [Default=""]
        stateID - longAn ID to identify the report manipulation state. [Default=-1]
        status - Output Parameter - returns a value of EnumDSSXMLStatus - returns status of request.
        jobId - Output parameter - return the jobid
        Returns:
        If the report is finished execution, then the report XML will be returned. Otherwise, nothing will be returned.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • SaveAs

        java.lang.String SaveAs​(java.lang.String sessionID,
                        java.lang.String messageID,
                        java.lang.String folderID,
                        java.lang.String reportName,
                        java.lang.String reportDesc,
                        int viewIndex,
                        int flags,
                        int dispMode,
                        int stateID)
                 throws MSTRWebAPIException
        This method saves a report.

        All report manipulations (page-by, pivot, sort etc.) contained in the message (indexed by the messageID) will be retained when saving the report.

        If the reportName is left out, the original report name will be retained. If it is left empty and the original name is empty as is possible in the case of a drilled report, then an error will be returned.

        Refer to the remarks of IDSSXMLReportServer.GetExecutionResults for details of the stateID parameter. The report state being saved is identified by this parameter. By default, the final state of the report is saved.

        Parameters:
        sessionID - A valid Session ID.
        messageID - Message ID corresponding to the report to be saved.
        folderID - Folder in which the report should be saved.
        reportName - Save the report as this name.
        reportDesc - Give the new report this description.
        viewIndex - The index of a view (template) to be applied. [Default=0]
        flags - - Different saving options - comes from EnumDSSXMLReportSaveAsFlags. [Default=DssXmlReportSaveAsDefault] The following combinations of flags are likely to be the most useful:
        • Zero (0) - In this case, the user will not be prompted the next time he runs the report, and there will be no way for him to be re-prompted in the future.
        • DssXmlReportSaveAsOriginalFilter - Save the template as static and the filter as prompted, but discard the current filter prompt answers.
        • DssXmlReportSaveAsOriginalFilter + DssXmlReportSaveAsWithAnswers + DssXmlReportSaveAsPruneAnswers - Save the template as static, save the filter as prompted, and save the current filter prompt answers along with the report. Re-prompt when the report is opened using the saved answers as the default selections.
        • DssXmlReportSaveAsOriginalFilter + DssXmlReportSaveAsWithAnswers + DssXmlReportSaveAsPruneAnswers + DssXmlReportSaveAsDeclinePrompts - Save the template as static, save the filter as prompted, and save the current filter prompt answers along with the report. Do not re-prompt when the report is opened, but if the user clicks "refresh" then re-prompt using the saved answers as the default selections.
        dispMode - Report display mode. Value must be from EnumDSSXMLDisplayMode. [Default=DssXmlDisplayModeGrid]
        stateID - ID that identifies the report manipulation state. [Default=-1]
        Returns:
        Object ID of the new report created.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • SaveAs

        java.lang.String SaveAs​(java.lang.String sessionID,
                        java.lang.String messageID,
                        java.lang.String folderID,
                        java.lang.String reportName,
                        java.lang.String reportDesc,
                        int viewIndex,
                        int flags,
                        int dispMode,
                        int stateID,
                        StringWrapper msgId)
                 throws MSTRWebAPIException
        This method saves a report.

        All report manipulations (page-by, pivot, sort etc.) contained in the message (indexed by the messageID) will be retained when saving the report.

        If the reportName is left out, the original report name will be retained. If it is left empty and the original name is empty as is possible in the case of a drilled report, then an error will be returned.

        Refer to the remarks of IDSSXMLReportServer.GetExecutionResults for details of the stateID parameter. The report state being saved is identified by this parameter. By default, the final state of the report is saved.

        Parameters:
        sessionID - A valid Session ID.
        messageID - Message ID corresponding to the report to be saved.
        folderID - Folder in which the report should be saved.
        reportName - Save the report as this name.
        reportDesc - Give the new report this description.
        viewIndex - The index of a view (template) to be applied. [Default=0]
        flags - - Different saving options - comes from EnumDSSXMLReportSaveAsFlags. [Default=DssXmlReportSaveAsDefault] The following combinations of flags are likely to be the most useful:
        • Zero (0) - In this case, the user will not be prompted the next time he runs the report, and there will be no way for him to be re-prompted in the future.
        • DssXmlReportSaveAsOriginalFilter - Save the template as static and the filter as prompted, but discard the current filter prompt answers.
        • DssXmlReportSaveAsOriginalFilter + DssXmlReportSaveAsWithAnswers + DssXmlReportSaveAsPruneAnswers - Save the template as static, save the filter as prompted, and save the current filter prompt answers along with the report. Re-prompt when the report is opened using the saved answers as the default selections.
        • DssXmlReportSaveAsOriginalFilter + DssXmlReportSaveAsWithAnswers + DssXmlReportSaveAsPruneAnswers + DssXmlReportSaveAsDeclinePrompts - Save the template as static, save the filter as prompted, and save the current filter prompt answers along with the report. Do not re-prompt when the report is opened, but if the user clicks "refresh" then re-prompt using the saved answers as the default selections.
        dispMode - Report display mode. Value must be from EnumDSSXMLDisplayMode. [Default=DssXmlDisplayModeGrid]
        stateID - ID that identifies the report manipulation state. [Default=-1]
        msgID - Output Parameter - Returns the resultant message ID from submitting this operation. Note that if this ID has changed, then the state ID should be reset to 0 to get the results, but if the message ID is the same, then the state ID should be increased by 1 in order to get the results of this execution.
        Returns:
        Object ID of the new report created.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • SaveAs

        java.lang.String SaveAs​(java.lang.String sessionID,
                        java.lang.String messageID,
                        java.lang.String folderID,
                        java.lang.String reportName,
                        java.lang.String reportDesc,
                        int viewIndex,
                        int flags,
                        int dispMode,
                        int stateID,
                        StringWrapper msgId,
                        int requestTimeout)
                 throws MSTRWebAPIException
        This method saves a report.

        All report manipulations (page-by, pivot, sort etc.) contained in the message (indexed by the messageID) will be retained when saving the report.

        If the reportName is left out, the original report name will be retained. If it is left empty and the original name is empty as is possible in the case of a drilled report, then an error will be returned.

        Refer to the remarks of IDSSXMLReportServer.GetExecutionResults for details of the stateID parameter. The report state being saved is identified by this parameter. By default, the final state of the report is saved.

        Parameters:
        sessionID - A valid Session ID.
        messageID - Message ID corresponding to the report to be saved.
        folderID - Folder in which the report should be saved.
        reportName - Save the report as this name.
        reportDesc - Give the new report this description.
        viewIndex - The index of a view (template) to be applied. [Default=0]
        flags - - Different saving options - comes from EnumDSSXMLReportSaveAsFlags. [Default=DssXmlReportSaveAsDefault] The following combinations of flags are likely to be the most useful:
        • Zero (0) - In this case, the user will not be prompted the next time he runs the report, and there will be no way for him to be re-prompted in the future.
        • DssXmlReportSaveAsOriginalFilter - Save the template as static and the filter as prompted, but discard the current filter prompt answers.
        • DssXmlReportSaveAsOriginalFilter + DssXmlReportSaveAsWithAnswers + DssXmlReportSaveAsPruneAnswers - Save the template as static, save the filter as prompted, and save the current filter prompt answers along with the report. Re-prompt when the report is opened using the saved answers as the default selections.
        • DssXmlReportSaveAsOriginalFilter + DssXmlReportSaveAsWithAnswers + DssXmlReportSaveAsPruneAnswers + DssXmlReportSaveAsDeclinePrompts - Save the template as static, save the filter as prompted, and save the current filter prompt answers along with the report. Do not re-prompt when the report is opened, but if the user clicks "refresh" then re-prompt using the saved answers as the default selections.
        dispMode - Report display mode. Value must be from EnumDSSXMLDisplayMode. [Default=DssXmlDisplayModeGrid]
        stateID - ID that identifies the report manipulation state. [Default=-1]
        msgID - Output Parameter - Returns the resultant message ID from submitting this operation. Note that if this ID has changed, then the state ID should be reset to 0 to get the results, but if the message ID is the same, then the state ID should be increased by 1 in order to get the results of this execution.
        requestTimeout - Request timeout value. It is used to override the default session request timeout value for the saving job. By default it's -1.
        Returns:
        Object ID of the new report created.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • ExecuteFT

        java.lang.String ExecuteFT​(java.lang.String sessionID,
                           java.lang.String filterID,
                           java.lang.String templateID,
                           int executionFlags,
                           int resultFlags,
                           java.lang.String promptAnswer,
                           java.lang.String viewSetting,
                           java.lang.String windowSetting,
                           java.lang.String styleXSL,
                           java.lang.String webProperties,
                           StringWrapper msgID,
                           IntWrapper status)
                    throws MSTRWebAPIException
        This method executes a report by a combination of a filter ID and a template ID.
        Parameters:
        sessionID - A valid Session ID.
        filterID - The object ID of a filter.
        templateID - The object ID of a template.
        executionFlags - Flags specify different options for the execution. Value must be a bitwise "or" (addition) of values from EnumDSSXMLExecutionFlags. [Default=DssXmlExecutionUseCache + DssXmlExecutionUpdateCache]
        resultFlags - Tells the server how to present the results. This value must be a bitwise "or" (addition) of values from EnumDSSXMLResultFlags. [Default=0]
        promptAnswer - Answer(s) to prompt(s), if any, in the report execution. [Default=""]
        viewSetting - XML (containing view index, deltaXML, grid/graph properties) for setting the view of the report. [Default=""]
        windowSetting - XML (starting row, starting column, max row, max column) for a display window. [Default=""]
        styleXSL - Optional XSL to be applied to XML to generate HTML. [Default=""]
        webProperties - Properties associated with this report. [Default=""]
        msgID - Output Parameter returns message ID.
        status - Output Parameter - returns a value of EnumDSSXMLStatus - returns status of request.
        Returns:
        The result of this operation. Note that generally it is necessary to call GetExecutionResults to get the resulting report.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • ReBuildReportEx

        java.lang.String ReBuildReportEx​(java.lang.String sessionID,
                                 java.lang.String messageID,
                                 int executionFlags,
                                 int resultFlags,
                                 java.lang.String viewSettings,
                                 java.lang.String windowSetting,
                                 java.lang.String styleXSL,
                                 java.lang.String webProperties,
                                 int stateID,
                                 StringWrapper msgID,
                                 IntWrapper status)
                          throws MSTRWebAPIException
        This method submits a report manipulation. This method takes a report manipulation XML and submits it to the server, to enable any query & reporting manipulation. This method will send the resultant message ID in the msgID parameter. If this message ID is the same as the one passed into the API, then the state ID must be increased by 1 in order to refer to the modified report instance. If the message IDs are different, then a new report instance was created, and that message ID, with state ID 0, must be used to refer to the report with the given manipulations
        Parameters:
        sessionID - A valid session ID.
        messageID - The message ID of the report to manipulate.
        executionFlags - Flags specify different options for the execution. Value must be a bitwise "or" (addition) of values from EnumDSSXMLExecutionFlags. [Default=DssXmlExecutionReBuildPreviewOnly]
        resultFlags - Tells the server how to present the results. This value must be a bitwise "or" (addition) of values from EnumDSSXMLResultFlags. [Default=0]
        viewSettings - XML (containing view index, deltaXML, grid/graph properties) for setting the view of the report. [Default=""]
        windowSetting - XML (starting row, starting column, max row, max column) for a display window. [Default=""]
        styleXSL - Optional XSL to be applied to XML to generate HTML. [Default=""]
        webProperties - Properties associated with this report. [Default=""]
        stateID - longAn ID to identify the report manipulation state. [Default=-1]
        msgID - Output Parameter - Returns the resultant message ID from submitting this operation. Note that if this ID has changed, then the state ID should be reset to 0 to get the results, but if the message ID is the same, then the state ID should be increased by 1 in order to get the results of this execution.
        status - Output Parameter - returns a value of EnumDSSXMLStatus - returns status of request.
        Returns:
        The result of this operation. Note that generally it is necessary to call GetExecutionResults to get the resulting report.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • ReBuildReportEx

        java.lang.String ReBuildReportEx​(java.lang.String sessionID,
                                 java.lang.String messageID,
                                 int executionFlags,
                                 int resultFlags,
                                 java.lang.String viewSettings,
                                 java.lang.String windowSetting,
                                 java.lang.String extParam,
                                 java.lang.String styleXSL,
                                 java.lang.String webProperties,
                                 int stateID,
                                 StringWrapper msgID,
                                 IntWrapper status)
                          throws MSTRWebAPIException
        This method submits a report manipulation. This method takes a report manipulation XML and submits it to the server, to enable any query & reporting manipulation. This method will send the resultant message ID in the msgID parameter. If this message ID is the same as the one passed into the API, then the state ID must be increased by 1 in order to refer to the modified report instance. If the message IDs are different, then a new report instance was created, and that message ID, with state ID 0, must be used to refer to the report with the given manipulations
        Parameters:
        sessionID - A valid session ID.
        messageID - The message ID of the report to manipulate.
        executionFlags - Flags specify different options for the execution. Value must be a bitwise "or" (addition) of values from EnumDSSXMLExecutionFlags. [Default=DssXmlExecutionReBuildPreviewOnly]
        resultFlags - Tells the server how to present the results. This value must be a bitwise "or" (addition) of values from EnumDSSXMLResultFlags. [Default=0]
        viewSettings - XML (containing view index, deltaXML, grid/graph properties) for setting the view of the report. [Default=""]
        windowSetting - XML (starting row, starting column, max row, max column) for a display window. [Default=""]
        extParam - extendable parameter
        styleXSL - Optional XSL to be applied to XML to generate HTML. [Default=""]
        webProperties - Properties associated with this report. [Default=""]
        stateID - longAn ID to identify the report manipulation state. [Default=-1]
        msgID - Output Parameter - Returns the resultant message ID from submitting this operation. Note that if this ID has changed, then the state ID should be reset to 0 to get the results, but if the message ID is the same, then the state ID should be increased by 1 in order to get the results of this execution.
        status - Output Parameter - returns a value of EnumDSSXMLStatus - returns status of request.
        Returns:
        The result of this operation. Note that generally it is necessary to call GetExecutionResults to get the resulting report.
        Throws:
        MSTRWebAPIException - Signals an error condition.
        Since:
        MicroStrategy Web 8.0.0

      • ReBuildReportEx

        java.lang.String ReBuildReportEx​(java.lang.String sessionID,
                                 java.lang.String messageID,
                                 int executionFlags,
                                 int resultFlags,
                                 java.lang.String viewSettings,
                                 java.lang.String windowSetting,
                                 java.lang.String extParam,
                                 java.lang.String styleXSL,
                                 java.lang.String webProperties,
                                 int stateID,
                                 int requestTimeout,
                                 StringWrapper msgID,
                                 IntWrapper status)
                          throws MSTRWebAPIException
        This method submits a report manipulation. This method takes a report manipulation XML and submits it to the server, to enable any query & reporting manipulation. This method will send the resultant message ID in the msgID parameter. If this message ID is the same as the one passed into the API, then the state ID must be increased by 1 in order to refer to the modified report instance. If the message IDs are different, then a new report instance was created, and that message ID, with state ID 0, must be used to refer to the report with the given manipulations
        Parameters:
        sessionID - A valid session ID.
        messageID - The message ID of the report to manipulate.
        executionFlags - Flags specify different options for the execution. Value must be a bitwise "or" (addition) of values from EnumDSSXMLExecutionFlags. [Default=DssXmlExecutionReBuildPreviewOnly]
        resultFlags - Tells the server how to present the results. This value must be a bitwise "or" (addition) of values from EnumDSSXMLResultFlags. [Default=0]
        viewSettings - XML (containing view index, deltaXML, grid/graph properties) for setting the view of the report. [Default=""]
        windowSetting - XML (starting row, starting column, max row, max column) for a display window. [Default=""]
        extParam - extendable parameter
        styleXSL - Optional XSL to be applied to XML to generate HTML. [Default=""]
        webProperties - Properties associated with this report. [Default=""]
        stateID - longAn ID to identify the report manipulation state. [Default=-1]
        requestTimeout - Alternative session request timeout value to be used to override the default session timeout. [Default=-1]
        msgID - Output Parameter - Returns the resultant message ID from submitting this operation. Note that if this ID has changed, then the state ID should be reset to 0 to get the results, but if the message ID is the same, then the state ID should be increased by 1 in order to get the results of this execution.
        status - Output Parameter - returns a value of EnumDSSXMLStatus - returns status of request.
        Returns:
        The result of this operation. Note that generally it is necessary to call GetExecutionResults to get the resulting report.
        Throws:
        MSTRWebAPIException - Signals an error condition.
        Since:
        MicroStrategy Web 8.0.0

      • GetReportElements

        java.lang.String GetReportElements​(java.lang.String sessionID,
                                   java.lang.String messageID,
                                   java.lang.String objectID,
                                   int type,
                                   java.lang.String filter,
                                   int blockBegin,
                                   int blockCount)
                            throws MSTRWebAPIException
        Returns the elements within the working set of a specific report for a given object.
        Parameters:
        sessionID - A valid Intelligence Server session ID.
        messageID - The message ID of the report whose working set is being referred to.
        objectID - The object to retrieve the elements of.
        type - A value from EnumDSSXMLObjectTypes, this should specify the type of object given as objectID.
        filter - A filter to apply to the elements before returning them.
        blockBegin - The first element to return in the list of elements.
        blockCount - The maximum number of elements to return in this call.
        Returns:
        The result XML from the Intelligence Server. This will generally be standard element browsing XML.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • GetReportElements

        java.lang.String GetReportElements​(java.lang.String sessionID,
                                   java.lang.String messageID,
                                   java.lang.String objectID,
                                   int type,
                                   java.lang.String filter,
                                   int blockBegin,
                                   int blockCount,
                                   int flags)
                            throws MSTRWebAPIException
        Returns the elements within the working set of a specific report for a given object.
        Parameters:
        sessionID - A valid Intelligence Server session ID.
        messageID - The message ID of the report whose working set is being referred to.
        objectID - The object to retrieve the elements of.
        type - A value from EnumDSSXMLObjectTypes, this should specify the type of object given as objectID.
        filter - A filter to apply to the elements before returning them.
        blockBegin - The first element to return in the list of elements.
        blockCount - The maximum number of elements to return in this call.
        flags - Flags to use when element browsing. This value comes from EnumDSSXMLGetElementsFlags.
        Returns:
        The result XML from the Intelligence Server. This will generally be standard element browsing XML.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • GetReportElements

        java.lang.String GetReportElements​(java.lang.String sessionID,
                                   java.lang.String messageID,
                                   java.lang.String objectID,
                                   int type,
                                   java.lang.String filter,
                                   java.lang.String forms,
                                   int blockBegin,
                                   int blockCount,
                                   int flags)
                            throws MSTRWebAPIException
        Returns the elements within the working set of a specific report for a given object.
        Parameters:
        sessionID - A valid Intelligence Server session ID.
        messageID - The message ID of the report whose working set is being referred to.
        objectID - The object to retrieve the elements of.
        type - A value from EnumDSSXMLObjectTypes, this should specify the type of object given as objectID.
        filter - A filter to apply to the elements before returning them.
        forms - Specified the list of forms
        blockBegin - The first element to return in the list of elements.
        blockCount - The maximum number of elements to return in this call.
        flags - Flags to use when element browsing. This value comes from EnumDSSXMLGetElementsFlags.
        Returns:
        The result XML from the Intelligence Server. This will generally be standard element browsing XML.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • Export

        java.lang.String Export​(java.lang.String sessionID,
                        java.lang.String messageID,
                        int exportFormat,
                        java.lang.String export_parameter,
                        int stateID,
                        IntWrapper status)
                 throws MSTRWebAPIException
        Returns the report in a comma-delimited format. This format is generally meant to be used to export a report to an external source.
        Parameters:
        sessionID - A valid Intelligence Server session ID.
        messageID - The message ID of the report instance to export.
        exportFormat - The format to export in, from EnumDSSXMLExportFormat.
        export_parameter - The export parameter to send to the Intelligence Server.
        stateID - The state ID of the report instance to export.
        status - An IntWrapper which will be filled with the status of the operation.
        Returns:
        The string result of the export call.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • BinaryExportAsync

        byte[] BinaryExportAsync​(java.lang.String sessionID,
                         java.lang.String messageID,
                         int exportFormat,
                         IntWrapper iwStatus)
                  throws MSTRWebAPIException
        Returns the exported data in a binary format (for instance while retrieving PDF data).
        Parameters:
        sessionID - A valid Intelligence Server session ID.
        messageID - The message ID of the report instance to export.
        exportFormat - The format to export in, from EnumDSSXMLExportFormat.
        iwStatus - An IntWrapper which will be filled with the status of the operation.
        Returns:
        The string result of the export call.
        Throws:
        MSTRWebAPIException - Signals an error condition.
        Since:
        MicroStrategy Web 8.0.0

      • GetExecutionResultsEx

        java.lang.String GetExecutionResultsEx​(java.lang.String sessionID,
                                       java.lang.String messageID,
                                       int resultFlags,
                                       java.lang.String windowSetting,
                                       int stateID,
                                       java.lang.String extendableParameter,
                                       IntWrapper status)
                                throws MSTRWebAPIException
        This method retrieves the results of report execution.

        This method is used to retrieve report execution result or prompt question (if the report contains a prompt). This method needs to be called when any executions methods returned with a messageID only (status = EnumDSSXMLResultFlags.DssXmlResultMsgID). Usually this method is in a loop. The termination condition of the loop would be status = DssXmlStatusResult, status = DssXmlStatusPromptXML or status = DssXmlStatusErrMsgXML. You should put a delay in the loop to prevent the server being pulled too frequently.

        Report settings (report mode, display window) will not be persisted. That means, if you use GetExecutionResults to change a report mode from grid to graph. Retrieving the report from the inbox, you will still get a report in grid mode. To persist a report setting, use either Execute or ReBuildReport. Report setting in GetExecutionResults will overwrite the same settings in Execute and ReBuildReport. To keep the original settings specified in Execute or ReBuildReport, do not specify the settings when calling GetExecutionResults.

        A report can be manipulated multiple times (pivot twice and then sort for example). A Web user can also use the back button of a browser to return to any of the report state. The stateID parameter is used to identify each state. The original report has stateID = 0. Subsequent report manipulation will increment the stateID by one.

        This method takes a stateID as an optional parameter. Using the default parameter for this argument will cause the report with the most recent state ID to be returned.

        Any stateID that is higher than the highest stateID of a report will result in an error.

        Parameters:
        sessionID - A valid Session ID
        messageID - The ID of the job/message to retrieve.
        resultFlags - EnumDSSXMLResultFlags - Specifies the options to apply to getting the report result. [Default=DssXmlResultPreserve]
        windowSetting - XML for a display window. [Default=""]
        stateID - ID that identifies the report manipulation state. [Default=-1]
        extendableParameter - An XML parameter which is used for various options used when getting results from the Intelligence Server. In the 7.2.1 release, this is used to specify properties to obtain.
        status - Output Parameter - Status of the report execution - value comes from EnumDSSXMLStatus.
        Returns:
        String representing the XML returned for the report, if it is ready. It could also contain prompt question XML, if the report is waiting for a prompt to be answered; Null if result is not ready; an error message if an error happened.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • GetExportResults

        java.lang.String GetExportResults​(java.lang.String sessionID,
                                  java.lang.String messageID,
                                  int format,
                                  IntWrapper status)
                           throws MSTRWebAPIException
        Returns export results in the given format for the given report.
        Parameters:
        sessionID - A valid session ID.
        messageID - The message ID of the report instance.
        format - The format of the export operation, from EnumDSSXMLExportFormat.
        status - The status of the report, from EnumDSSXMLStatus.
        Returns:
        The requested output. This will only be present if the status is ready.
        Throws:
        MSTRWebAPIException - Signals an error condition.
        Since:
        MicroStrategy Web 8.0.0

      • GetCubeElements

        java.lang.String GetCubeElements​(java.lang.String sessionID,
                                 java.lang.String objectID,
                                 int type,
                                 java.lang.String filter,
                                 int blockBegin,
                                 int blockCount,
                                 java.lang.String cubeSources)
                          throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException
        Since:
        MicroStrategy Web 9.0.0

      • GetCubeObjects

        java.lang.String GetCubeObjects​(java.lang.String sessionID,
                                int blockBegin,
                                int blockCount,
                                java.lang.String cubeSources)
                         throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException
        Since:
        MicroStrategy Web 9.0.0

      • SaveDerivedElements

        java.lang.String SaveDerivedElements​(java.lang.String sessionID,
                                     java.lang.String messageID,
                                     java.lang.String attId,
                                     java.lang.String folderId,
                                     java.lang.String name,
                                     java.lang.String description,
                                     boolean overwrite,
                                     IntWrapper status)
                              throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException
        Since:
        MicroStrategy Web 9.0.0

      • CubeExecuteSearch

        java.lang.String CubeExecuteSearch​(java.lang.String sessionID,
                                   java.lang.String cubeSources,
                                   java.lang.String searchXML,
                                   int blockBegin,
                                   int blockCount,
                                   int searchFlags,
                                   int workingSetSearchFlags)
                            throws MSTRWebAPIException
        Returns search results for executing a search within a cube.
        Parameters:
        sessionID - A valid session ID.
        cubeSources - The dataSources XML containing the information regarding the cube.
        searchXML - Search definition xml.
        blockBegin - The first object to return from the search.
        blockCount - The total number of objects to return from the search.
        searchFlags - The object flags to indicate the amount of information returned.
        workingSetSearchFlags - The flags specific to CubeSearch Currently this value is not used.
        Throws:
        MSTRWebAPIException - Signals an error condition.
        Since:
        MicroStrategy Web 9.0.0

      • GetExecutionResultsAsStream

        IResultsAsStream GetExecutionResultsAsStream​(java.lang.String sessionID,
                                             java.lang.String messageID,
                                             int resultFlags,
                                             java.lang.String windowSetting,
                                             int stateID,
                                             java.lang.String extendableParameter)
                                      throws MSTRWebAPIException
        This method retrieves the results of report execution and returns them to the caller as a stream. It is used to directly stream report XML to the parser.

        This method is used to retrieve report execution result or prompt question (if the report contains a prompt). This method needs to be called when any executions methods returned with a messageID only (status = EnumDSSXMLResultFlags.DssXmlResultMsgID). Usually this method is in a loop. The termination condition of the loop would be status = DssXmlStatusResult, status = DssXmlStatusPromptXML or status = DssXmlStatusErrMsgXML. You should put a delay in the loop to prevent the server being pulled too frequently.

        Report settings (report mode, display window) will not be persisted. That means, if you use GetExecutionResults to change a report mode from grid to graph. Retrieving the report from the inbox, you will still get a report in grid mode. To persist a report setting, use either Execute or ReBuildReport. Report setting in GetExecutionResults will overwrite the same settings in Execute and ReBuildReport. To keep the original settings specified in Execute or ReBuildReport, do not specify the settings when calling GetExecutionResults.

        A report can be manipulated multiple times (pivot twice and then sort for example). A Web user can also use the back button of a browser to return to any of the report state. The stateID parameter is used to identify each state. The original report has stateID = 0. Subsequent report manipulation will increment the stateID by one.

        This method takes a stateID as an optional parameter. Using the default parameter for this argument will cause the report with the most recent state ID to be returned.

        Any stateID that is higher than the highest stateID of a report will result in an error.

        Parameters:
        sessionID - A valid Session ID
        messageID - The ID of the job/message to retrieve.
        resultFlags - EnumDSSXMLResultFlags - Specifies the options to apply to getting the report result. [Default=DssXmlResultPreserve]
        windowSetting - XML for a display window. [Default=""]
        stateID - ID that identifies the report manipulation state. [Default=-1]
        extendableParameter - An XML parameter which is used for various options used when getting results from the Intelligence Server. In the 7.2.1 release, this is used to specify properties to obtain.
        Returns:
        String representing the XML returned for the report, if it is ready. It could also contain prompt question XML, if the report is waiting for a prompt to be answered; Null if result is not ready; an error message if an error happened.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • ImportCube

        java.lang.String ImportCube​(java.lang.String sessionID,
                            java.lang.String reportID,
                            java.lang.String fileName,
                            java.lang.String fileType,
                            long fileLength,
                            java.io.InputStream data,
                            int executionFlags,
                            int resultFlags,
                            java.lang.String extParam,
                            StringWrapper msgID,
                            IntWrapper status)
                     throws MSTRWebAPIException
        Create a cube on the IServer based on the file passed in
        Parameters:
        sessionID - String containing the id of the session this command is to be associated with
        reportID - containing the id of the report, for republishing
        fileName - String containing the name of the file
        fileType - int specifying MIME content type
        fileLength - int specifying the length of the file
        data - InputStream containing the file
        executionFlags - int specifying which flags from EnumDSSXMLExecutionFlags should be used in the new cube's execution
        resultFlags - int specifying which flags from EnumDSSXMLResultFlags should be used to gather the results for the new cube's execution
        extParam - String containing xml specifying extra parameters for the new cube's execution
        msgID - StringWrapper that will contain the message id of the new cube once the command has returned
        status - IntWrapper that will contain the resulting status of this command once it has returned
        Returns:
        String containing nothing. In place for future use
        Throws:
        MSTRWebAPIException

      • ImportCube

        java.lang.String ImportCube​(java.lang.String sessionID,
                            java.lang.String reportID,
                            java.lang.String fileName,
                            java.lang.String fileType,
                            long fileLength,
                            java.io.InputStream data,
                            int executionFlags,
                            int resultFlags,
                            java.lang.String extParam,
                            java.lang.String documentID,
                            StringWrapper msgID,
                            IntWrapper status)
                     throws MSTRWebAPIException
        Create a cube on the IServer based on the file passed in
        Parameters:
        sessionID - String containing the id of the session this command is to be associated with
        reportID - containing the id of the report, for republishing
        fileName - String containing the name of the file
        fileType - int specifying MIME content type
        fileLength - int specifying the length of the file
        data - InputStream containing the file
        executionFlags - int specifying which flags from EnumDSSXMLExecutionFlags should be used in the new cube's execution
        resultFlags - int specifying which flags from EnumDSSXMLResultFlags should be used to gather the results for the new cube's execution
        extParam - String containing xml specifying extra parameters for the new cube's execution
        documentID - The ID of the document that the cube will be used on. (Used for attribute/metric mapping)
        msgID - StringWrapper that will contain the message id of the new cube once the command has returned
        status - IntWrapper that will contain the resulting status of this command once it has returned
        Returns:
        String containing nothing. In place for future use
        Throws:
        MSTRWebAPIException

      • ImportCube

        java.lang.String ImportCube​(java.lang.String sessionID,
                            java.lang.String reportID,
                            java.lang.String fileName,
                            java.lang.String fileType,
                            long fileLength,
                            java.io.InputStream data,
                            int executionFlags,
                            int resultFlags,
                            int behaviorFlags,
                            java.lang.String extParam,
                            java.lang.String documentID,
                            StringWrapper msgID,
                            IntWrapper status)
                     throws MSTRWebAPIException
        Create a cube on the IServer based on the file passed in
        Parameters:
        sessionID - String containing the id of the session this command is to be associated with
        reportID - containing the id of the report, for republishing
        fileName - String containing the name of the file
        fileType - int specifying MIME content type
        fileLength - int specifying the length of the file
        data - InputStream containing the file
        executionFlags - int specifying which flags from EnumDSSXMLExecutionFlags should be used in the new cube's execution
        resultFlags - int specifying which flags from EnumDSSXMLResultFlags should be used to gather the results for the new cube's execution
        behaviorFlags - int idc import behavior chagne flag
        extParam - String containing xml specifying extra parameters for the new cube's execution
        documentID - The ID of the document that the cube will be used on. (Used for attribute/metric mapping)
        msgID - StringWrapper that will contain the message id of the new cube once the command has returned
        status - IntWrapper that will contain the resulting status of this command once it has returned
        Returns:
        String containing nothing. In place for future use
        Throws:
        MSTRWebAPIException

      • ImportCube

        java.lang.String ImportCube​(java.lang.String sessionID,
                            java.lang.String messageID,
                            java.lang.String tableID,
                            java.lang.String reportID,
                            java.lang.String fileName,
                            java.lang.String fileType,
                            long fileLength,
                            java.io.InputStream data,
                            int executionFlags,
                            int resultFlags,
                            int behaviorFlags,
                            java.lang.String extParam,
                            java.lang.String documentID,
                            StringWrapper msgID,
                            IntWrapper status)
                     throws MSTRWebAPIException
        Create a cube on the IServer based on the file passed in, with support to EMMA msgID and source table ID
        Parameters:
        sessionID - String containing the id of the session this command is to be associated with
        msgID - message ID for EMMA cube
        tableID - source table ID for EMMA cube
        reportID - containing the id of the report, for republishing
        fileName - String containing the name of the file
        fileType - int specifying MIME content type
        fileLength - int specifying the length of the file
        data - InputStream containing the file
        executionFlags - int specifying which flags from EnumDSSXMLExecutionFlags should be used in the new cube's execution
        resultFlags - int specifying which flags from EnumDSSXMLResultFlags should be used to gather the results for the new cube's execution
        behaviorFlags - int idc import behavior chagne flag
        extParam - String containing xml specifying extra parameters for the new cube's execution
        documentID - The ID of the document that the cube will be used on. (Used for attribute/metric mapping)
        msgID - StringWrapper that will contain the message id of the new cube once the command has returned
        status - IntWrapper that will contain the resulting status of this command once it has returned
        Returns:
        String containing nothing. In place for future use
        Throws:
        MSTRWebAPIException

      • ImportCube

        java.lang.String ImportCube​(java.lang.String sessionID,
                            java.lang.String reportID,
                            java.lang.String url,
                            int executionFlags,
                            int resultFlags,
                            java.lang.String extParam,
                            StringWrapper msgID,
                            IntWrapper status)
                     throws MSTRWebAPIException
        Create a cube on the IServer based on a file at the specified url
        Parameters:
        sessionID - String containing the id of the session this command is to be associated with
        reportID - containing the id of the report, for republishing
        url - String containing the location of the file
        executionFlags - int specifying which flags from EnumDSSXMLExecutionFlags should be used in the new cube's execution
        resultFlags - int specifying which flags from EnumDSSXMLResultFlags should be used to gather the results for the new cube's execution
        extParam - String containing xml specifying extra parameters for the new cube's execution
        msgID - StringWrapper that will contain the message id of the new cube once the command has returned
        status - IntWrapper that will contain the resulting status of this command once it has returned
        Returns:
        String containing nothing. In place for future use
        Throws:
        MSTRWebAPIException

      • UploadWallet

        java.lang.String UploadWallet​(java.lang.String sessionID,
                              java.lang.String messageID,
                              java.lang.String tableID,
                              java.lang.String reportID,
                              java.lang.String fileName,
                              java.lang.String fileType,
                              long fileLength,
                              java.io.InputStream data,
                              int executionFlags,
                              int resultFlags,
                              int behaviorFlags,
                              java.lang.String extParam,
                              java.lang.String documentID,
                              StringWrapper msgID,
                              IntWrapper status,
                              java.lang.String did)
                       throws MSTRWebAPIException
        Create a cube on the IServer based on the wallet file passed in if no did passed in, with support to EMMA msgID and source table ID; Or save wallet file to disk if did is passed in.
        Parameters:
        sessionID - String containing the id of the session this command is to be associated with
        msgID - message ID for EMMA cube
        tableID - source table ID for EMMA cube
        reportID - containing the id of the report, for republishing
        fileName - String containing the name of the file
        fileType - int specifying MIME content type
        fileLength - int specifying the length of the file
        data - InputStream containing the file
        executionFlags - int specifying which flags from EnumDSSXMLExecutionFlags should be used in the new cube's execution
        resultFlags - int specifying which flags from EnumDSSXMLResultFlags should be used to gather the results for the new cube's execution
        behaviorFlags - int idc import behavior chagne flag
        extParam - String containing xml specifying extra parameters for the new cube's execution
        documentID - The ID of the document that the cube will be used on. (Used for attribute/metric mapping)
        msgID - StringWrapper that will contain the message id of the new cube once the command has returned
        status - IntWrapper that will contain the resulting status of this command once it has returned
        did - db role id
        Returns:
        String containing nothing. In place for future use
        Throws:
        MSTRWebAPIException

      • ChangeImportedCube

        java.lang.String ChangeImportedCube​(java.lang.String sessionID,
                                    java.lang.String reportID,
                                    int sheetIndex,
                                    java.lang.String colHeaders,
                                    boolean isUrl,
                                    java.lang.String transformations,
                                    int executionFlags,
                                    int resultFlags,
                                    java.lang.String extParam,
                                    StringWrapper msgID,
                                    IntWrapper status)
                             throws MSTRWebAPIException
        Change the sheet index or insert new column headers on a imported cube
        Parameters:
        sessionID -
        reportID -
        sheetIndex -
        colHeaders -
        executionFlags -
        resultFlags -
        extParam -
        msgID -
        status -
        Returns:
        Throws:
        MSTRWebAPIException

      • ChangeImportedCube

        java.lang.String ChangeImportedCube​(java.lang.String sessionID,
                                    java.lang.String reportID,
                                    int sheetIndex,
                                    java.lang.String colHeaders,
                                    boolean isUrl,
                                    java.lang.String transformations,
                                    java.lang.String dbRoleID,
                                    java.lang.String sourceAccountID,
                                    int executionFlags,
                                    int resultFlags,
                                    int behaviorFlags,
                                    java.lang.String extParam,
                                    StringWrapper msgID,
                                    IntWrapper status)
                             throws MSTRWebAPIException
        Change the sheet index or insert new column headers on a imported cube, with support to cubes imported form OAuth source, and support idc behavior change flag
        Parameters:
        sessionID -
        reportID -
        sheetIndex -
        colHeaders -
        isUrl -
        transformations -
        dbRoleID -
        sourceAccountID -
        executionFlags -
        resultFlags -
        flag -
        extParam -
        msgID -
        status -
        Returns:
        Throws:
        MSTRWebAPIException

      • ChangeImportedCube

        java.lang.String ChangeImportedCube​(java.lang.String sessionID,
                                    java.lang.String reportID,
                                    int sheetIndex,
                                    java.lang.String colHeaders,
                                    boolean isUrl,
                                    java.lang.String transformations,
                                    java.lang.String dbRoleID,
                                    java.lang.String sourceAccountID,
                                    int executionFlags,
                                    int resultFlags,
                                    int behaviorFlags,
                                    java.lang.String extParam,
                                    StringWrapper msgID,
                                    IntWrapper status,
                                    java.lang.String documentID)
                             throws MSTRWebAPIException
        Change the sheet index or insert new column headers on a imported cube, with support to cubes imported form OAuth source, and support idc behavior change flag
        Parameters:
        sessionID -
        reportID -
        sheetIndex -
        colHeaders -
        isUrl -
        transformations -
        dbRoleID -
        sourceAccountID -
        executionFlags -
        resultFlags -
        flag -
        extParam -
        msgID -
        status -
        documentID -
        Returns:
        Throws:
        MSTRWebAPIException

      • ImportCube

        java.lang.String ImportCube​(java.lang.String sessionID,
                            java.lang.String reportID,
                            java.lang.String url,
                            int executionFlags,
                            int resultFlags,
                            java.lang.String extParam,
                            java.lang.String documentID,
                            StringWrapper msgID,
                            IntWrapper status)
                     throws MSTRWebAPIException
        Create a cube on the IServer based on a file at the specified url
        Parameters:
        sessionID - String containing the id of the session this command is to be associated with
        reportID - containing the id of the report, for republishing
        url - String containing the location of the file
        executionFlags - int specifying which flags from EnumDSSXMLExecutionFlags should be used in the new cube's execution
        resultFlags - int specifying which flags from EnumDSSXMLResultFlags should be used to gather the results for the new cube's execution
        extParam - String containing xml specifying extra parameters for the new cube's execution
        documentID - The ID of the document that the cube will be used on. (Used for attribute/metric mapping)
        msgID - StringWrapper that will contain the message id of the new cube once the command has returned
        status - IntWrapper that will contain the resulting status of this command once it has returned
        Returns:
        String containing nothing. In place for future use
        Throws:
        MSTRWebAPIException

      • ImportCube

        java.lang.String ImportCube​(java.lang.String sessionID,
                            java.lang.String reportID,
                            java.lang.String url,
                            int executionFlags,
                            int resultFlags,
                            int behaviorFlags,
                            java.lang.String extParam,
                            java.lang.String documentID,
                            StringWrapper msgID,
                            IntWrapper status)
                     throws MSTRWebAPIException
        Create a cube on the IServer based on a file at the specified url
        Parameters:
        sessionID - String containing the id of the session this command is to be associated with
        reportID - containing the id of the report, for republishing
        url - String containing the location of the file
        executionFlags - int specifying which flags from EnumDSSXMLExecutionFlags should be used in the new cube's execution
        resultFlags - int specifying which flags from EnumDSSXMLResultFlags should be used to gather the results for the new cube's execution
        behaviorFlags - int idc import behavior chagne flag
        extParam - String containing xml specifying extra parameters for the new cube's execution
        documentID - The ID of the document that the cube will be used on. (Used for attribute/metric mapping)
        msgID - StringWrapper that will contain the message id of the new cube once the command has returned
        status - IntWrapper that will contain the resulting status of this command once it has returned
        Returns:
        String containing nothing. In place for future use
        Throws:
        MSTRWebAPIException

      • ImportCube

        java.lang.String ImportCube​(java.lang.String sessionID,
                            java.lang.String messageID,
                            java.lang.String tableID,
                            java.lang.String reportID,
                            java.lang.String url,
                            int executionFlags,
                            int resultFlags,
                            int behaviorFlags,
                            java.lang.String extParam,
                            java.lang.String documentID,
                            StringWrapper msgID,
                            IntWrapper status)
                     throws MSTRWebAPIException
        Create a cube on the IServer based on a file at the specified url, with support to msgID and tableID for EMMA cube
        Parameters:
        sessionID - String containing the id of the session this command is to be associated with
        messageID - {String}
        tableID - {String}
        reportID - containing the id of the report, for republishing
        url - String containing the location of the file
        executionFlags - int specifying which flags from EnumDSSXMLExecutionFlags should be used in the new cube's execution
        resultFlags - int specifying which flags from EnumDSSXMLResultFlags should be used to gather the results for the new cube's execution
        behaviorFlags - int idc import behavior chagne flag
        extParam - String containing xml specifying extra parameters for the new cube's execution
        documentID - The ID of the document that the cube will be used on. (Used for attribute/metric mapping)
        msgID - StringWrapper that will contain the message id of the new cube once the command has returned
        status - IntWrapper that will contain the resulting status of this command once it has returned
        Returns:
        String containing nothing. In place for future use
        Throws:
        MSTRWebAPIException

      • ImportCube

        java.lang.String ImportCube​(java.lang.String sessionID,
                            java.lang.String messageID,
                            java.lang.String tableID,
                            java.lang.String reportID,
                            java.lang.String fileName,
                            java.lang.String fileType,
                            long length,
                            java.lang.String numOfChunks,
                            java.lang.String chunkSize,
                            java.lang.String index,
                            java.io.InputStream inputStream,
                            int executionFlags,
                            int resultFlags,
                            int behaviorFlags,
                            java.lang.String extParam,
                            java.lang.String documentID,
                            StringWrapper msgID,
                            IntWrapper status)
                     throws MSTRWebAPIException
        Create a cube on the IServer based on a file at the specified url, with support to msgID and tableID for EMMA cube. Import the file by chunks.
        Parameters:
        sessionID - String containing the id of the session this command is to be associated with
        messageID - {String} contain the message id of the new cube once the command has returned
        tableID - {String}
        reportID - containing the id of the report, for republishing
        fileName -
        fileType -
        length -
        numOfChunks - {String} the total number of chunks the file split into
        chunkSize - {String} the size of each chunk
        index - {String} the index of each chunks
        inputStream - InputStream containing the file
        executionFlags - int specifying which flags from EnumDSSXMLExecutionFlags should be used in the new cube's execution
        resultFlags - int specifying which flags from EnumDSSXMLResultFlags should be used to gather the results for the new cube's execution
        behaviorFlags - int idc import behavior chagne flag
        extParam - String containing xml specifying extra parameters for the new cube's execution
        documentID - The ID of the document that the cube will be used on. (Used for attribute/metric mapping)
        msgID - StringWrapper that will contain the message id of the new cube once the command has returned
        status - IntWrapper that will contain the resulting status of this command once it has returned
        Returns:
        String containing nothing. In place for future use
        Throws:
        MSTRWebAPIException

      • SetCubeMapping

        java.lang.String SetCubeMapping​(java.lang.String sessionID,
                                java.lang.String msgID,
                                java.lang.String mappingXML)
                         throws MSTRWebAPIException
        Set the row/column to attribute/metric mapping for the specified imported cube
        Parameters:
        sessionID - String containing the id of the session this command is to be associated with
        msgID - String containing the message id of the Cube to be modified
        mappingXML - String containing the XML used to modify the cube mapping
        Returns:
        String containing the message id of the report containing the correct cube mapping
        Throws:
        MSTRWebAPIException

      • SetCubeMapping

        java.lang.String SetCubeMapping​(java.lang.String sessionID,
                                java.lang.String msgID,
                                java.lang.String mappingXML,
                                java.lang.String cubeRepublishBehavior)
                         throws MSTRWebAPIException
        Set the row/column to attribute/metric mapping for the specified imported cube, with support to cube republishing behavior flag
        Parameters:
        sessionID - String containing the id of the session this command is to be associated with
        msgID - String containing the message id of the Cube to be modified
        mappingXML - String containing the XML used to modify the cube mapping
        cubeRepublishBehavior - String containing the cube republishing behavior flag
        Returns:
        String containing the message id of the report containing the correct cube mapping
        Throws:
        MSTRWebAPIException

      • SetCubeMapping

        java.lang.String SetCubeMapping​(java.lang.String sessionID,
                                java.lang.String msgID,
                                java.lang.String mappingXML,
                                java.lang.String cubeRepublishBehavior,
                                java.lang.String documentID)
                         throws MSTRWebAPIException
        Set the row/column to attribute/metric mapping for the specified imported cube, with support to cube republishing behavior flag
        Parameters:
        sessionID - String containing the id of the session this command is to be associated with
        msgID - String containing the message id of the Cube to be modified
        mappingXML - String containing the XML used to modify the cube mapping
        cubeRepublishBehavior - String containing the cube republishing behavior flag
        documentID - String containing the ID of the document for Cube Join
        Returns:
        String containing the message id of the report containing the correct cube mapping
        Throws:
        MSTRWebAPIException

      • SendExecutionResultsInBinary

        void SendExecutionResultsInBinary​(java.lang.String sessionID,
                                  java.lang.String messageID,
                                  int resultFlags,
                                  int detailFlags,
                                  int stateID,
                                  java.lang.String extendableParameter,
                                  IntWrapper iwStatus,
                                  IContentConsumer consumer)
                           throws MSTRWebAPIException
        Obtains the results/data of the report in binary format. Currently this is used to retrieve the data for the flex model in binary format. Note that the parameters like resultFlags and extendableParameter are currently not used and have been added for future use. Hence this method will always return the flex data in binary format at present.
        Parameters:
        sessionID - A valid session ID.
        messageID - The message ID of the report instance.
        resultFlags - The result flags for the retrieval, from EnumDSSXMLBinaryContextFlags.
        detailFlags - The detail flags for the retrieval, from EnumDSSXMLBinaryContextDetailFlags.
        stateID - The state ID of the report instance.
        extendableParameter - An XML string containing additional options.
        iwStatus - The status of the report instance, from EnumDSSXMLStatus.
        consumer - A IContentConsumer object which consumes the binary data that is generated by the intelligence server
        Throws:
        MSTRWebAPIException - Thrown if an error occurs.

      • GetExecutionResultsInBinary

        byte[] GetExecutionResultsInBinary​(java.lang.String sessionID,
                                   java.lang.String messageID,
                                   int resultFlags,
                                   int detailFlags,
                                   int stateID,
                                   java.lang.String extendableParameter,
                                   IntWrapper iwStatus)
                            throws MSTRWebAPIException
        Obtains the results/data of the report in binary format.
        Parameters:
        sessionID - A valid session ID.
        messageID - The message ID of the report instance.
        resultFlags - The result flags for the retrieval, from EnumDSSXMLBinaryContextFlags.
        detailFlags - The detail flags for the retrieval, from EnumDSSXMLBinaryContextDetailFlags.
        stateID - The state ID of the report instance.
        extendableParameter - An XML string containing additional options.
        iwStatus - The status of the report instance, from EnumDSSXMLStatus.
        Returns:
        The byte array representing the binary data of the report
        Throws:
        MSTRWebAPIException - Thrown if an error occurs.

      • GetCubeResultsInBinary

        byte[] GetCubeResultsInBinary​(java.lang.String sessionID,
                              java.lang.String reportID,
                              java.lang.String messageID,
                              int sheetIndex,
                              int resultFlags,
                              int detailFlags,
                              int stateID,
                              java.lang.String extendableParameter,
                              IntWrapper iwStatus)
                       throws MSTRWebAPIException
        Obtains the result/data of the cube from backend in bytes.
        Parameters:
        sessionID -
        reportID -
        messageID -
        sheetIndex -
        resultFlags -
        detailFlags -
        stateID -
        extendableParameter -
        iwStatus -
        Returns:
        Throws:
        MSTRWebAPIException

      • SendCubeResultsInBinary

        void SendCubeResultsInBinary​(java.lang.String sessionID,
                             java.lang.String reportID,
                             java.lang.String messageID,
                             int sheetIndex,
                             int resultFlags,
                             int detailFlags,
                             int stateID,
                             java.lang.String extendableParameter,
                             IntWrapper iwStatus,
                             IContentConsumer consumer)
                      throws MSTRWebAPIException
        Obtains the result/data of the cube from back in Binary.
        Parameters:
        sessionID -
        reportID -
        messageID -
        sheetIndex -
        resultFlags -
        detailFlags -
        stateID -
        extendableParameter -
        iwStatus -
        consumer -
        Throws:
        MSTRWebAPIException

      • GetProjectDISettings

        java.lang.String GetProjectDISettings​(java.lang.String sessionID,
                                      java.lang.String projectID)
                               throws MSTRWebAPIException
        return the project settings specific for data import.
        Parameters:
        sessionID -
        projectID -
        Returns:
        Throws:
        MSTRWebAPIException

      • GetBinaryFileContent

        java.lang.String GetBinaryFileContent​(java.lang.String sessionID,
                                      java.lang.String fileName,
                                      java.lang.String fileType,
                                      long fileLength,
                                      java.io.InputStream data,
                                      int maxNumElements,
                                      boolean preserveWhiteSpace,
                                      java.lang.String outputDelimiter)
                               throws MSTRWebAPIException
        Obtains the result/data of the binary file from backend
        Parameters:
        sessionID - String containing the id of the session this command is to be associated with
        fileName - String containing the name of the file
        fileType - String specifying MIME content type
        fileLength - int specifying the length of the file
        data - InputStream containing the file
        maxNumElements - int the maximum number of elements to return
        preserveWhiteSpace - boolean indicates if to strip off elements leading and trailing space
        outputDelimiter - String output delimiter
        Returns:
        String formatted data from binary file
        Throws:
        MSTRWebAPIException

      • GetJsonResults

        java.lang.Object GetJsonResults​(java.lang.String sessionID,
                                java.lang.String messageID,
                                int resultFlags,
                                int detailFlags,
                                java.lang.String windowSetting,
                                int stateID,
                                java.lang.String extendableParameter,
                                int mode,
                                IntWrapper status)
                         throws MSTRWebAPIException
        THIS METHOD IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT. THE METHOD IS SUBJECT TO CHANGE IN FUTURE RELEASES AND SOME METHODS AND PROPERTIES MAY NOT BE SUITABLE FOR CUSTOM DEVELOPMENT.
        Throws:
        MSTRWebAPIException

      • GetJsonResults

        java.lang.Object GetJsonResults​(java.lang.String sessionID,
                                java.lang.String messageID,
                                int resultFlags,
                                int detailFlags,
                                java.lang.String windowSetting,
                                int stateID,
                                java.lang.String extendableParameter,
                                int mode,
                                int version,
                                IntWrapper status)
                         throws MSTRWebAPIException
        THIS METHOD IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT. THE METHOD IS SUBJECT TO CHANGE IN FUTURE RELEASES AND SOME METHODS AND PROPERTIES MAY NOT BE SUITABLE FOR CUSTOM DEVELOPMENT. Now two JSON format supported and parameter version is introduced to distinguish them version 1: Old format without crosstab and JSON tree structure version 2: New format with crosstab support. Json is normalized with lookup table as "elements", row and column headers, data for grid data. Need backend to support more flags or new parameters: definition only, raw data only
        Throws:
        MSTRWebAPIException

      • BrowseReportAsJson

        java.lang.String BrowseReportAsJson​(java.lang.String sessionID,
                                    java.lang.String messageID,
                                    int browseReportFlag,
                                    int bindingTableObjectType,
                                    int dataPreviewJsonFlag,
                                    int autoMapFlag)
                             throws MSTRWebAPIException
        Obtains the JSON result/data of the report from IServer.
        Parameters:
        sessionID - String containing the id of the session this command is to be associated with
        messageID - String containing the message id of the Cube to be modified
        browseReportFlag - EnumDSSBrowseReportFlags
        bindingTableObjectType - EnumDSSBindingTableObjectTypes
        dataPreviewJsonFlag - EnumDSSDataPreviewJSONFlags
        autoMapFlag - Indicate whether need to trigger 'auto-mapping' or not. 1 for true, 0 for false
        Returns:
        Throws:
        MSTRWebAPIException

      • ValidateSourceTableForEmmaCube

        java.lang.String ValidateSourceTableForEmmaCube​(java.lang.String sessionID,
                                                java.lang.String messageID,
                                                java.lang.String stbXML)
                                         throws MSTRWebAPIException
        Validate the source tables for the EMMA cube.
        Parameters:
        sessionID - String containing the id of the session this command is to be associated with
        messageID - String containing the message id of the Cube to be modified
        stbXML - String containing xml specifying source tables to be validated
        Returns:
        Throws:
        MSTRWebAPIException

      • GetUserDICubeInfo

        java.lang.String GetUserDICubeInfo​(java.lang.String sessionId,
                                   java.lang.String projectId,
                                   java.lang.String userId,
                                   int option)
                            throws MSTRWebAPIException
        Get DI cube info for project and specified user
        Parameters:
        sessionId - String containing the id of the session this command is to be associated with
        projectId - String containing the id of the project
        userId - String containing the id of the user, send empty userId if want to query info for current login user
        option - EnumDSSXMLGetCubeQuotaAndInfosOption
        Returns:
        Throws:
        MSTRWebAPIException
        Since:
        MicroStrategy 10.8 and IServer 10.8 or later

      • BrowseReportAsJson

        java.lang.String BrowseReportAsJson​(java.lang.String sessionID,
                                    java.lang.String messageID,
                                    java.lang.String tableName,
                                    java.lang.String attrName,
                                    java.lang.String metricName,
                                    int browseReportFlag,
                                    int bindingTableObjectType,
                                    int dataPreviewJsonFlag,
                                    int autoMapFlag)
                             throws MSTRWebAPIException
        Obtains the JSON result/data of the report from IServer.
        Parameters:
        sessionID - String containing the id of the session this command is to be associated with
        messageID - String containing the message id of the Cube to be modified
        tableName - specify the tabel to be browsed
        attrName - specify the attribute to be browsed
        metricName - specify the metric to be browsed
        browseReportFlag - EnumDSSBrowseReportFlags
        bindingTableObjectType - EnumDSSBindingTableObjectTypes
        dataPreviewJsonFlag - EnumDSSDataPreviewJSONFlags
        autoMapFlag - Indicate whether need to trigger 'auto-mapping' or not. 1 for true, 0 for false
        Returns:
        Throws:
        MSTRWebAPIException