Package com.microstrategy.web.objects

Interface WebReportSource

  • public interface WebReportSource
    The WebReportSource interface allows the user to execute and retrieve report instances, along with giving access to many objects which have a supplemental usage in report execution. All report instances returned from this interface will have default result flag as EnumDSSXMLResultFlags.DssXmlResultPreserve bitwise or (|) EnumDSSXMLResultFlags.DssXmlResultNoDerivedPromptXML.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      WebReportInstance changeImportedCube​(int sheetIndex, java.lang.String colHeaders, java.lang.String reportID, java.lang.String msgID, boolean isUrl, java.lang.String transformations)
      Change the sheet index or insert new column headers on a imported cube
      WebReportInstance changeImportedCube​(int sheetIndex, java.lang.String colHeaders, java.lang.String reportID, java.lang.String msgID, boolean isUrl, java.lang.String transformations, java.lang.String dbRoleID, java.lang.String sourceAccountID, int behaviorFlags)
      Change the sheet index or insert new column headers on a imported cube, with support to cubes imported from OAuth source, and support idc behavior change flags
      WebReportInstance changeImportedCube​(int sheetIndex, java.lang.String colHeaders, java.lang.String reportID, java.lang.String msgID, boolean isUrl, java.lang.String transformations, java.lang.String dbRoleID, java.lang.String sourceAccountID, int behaviorFlags, java.lang.String documentID)
      Change the sheet index or insert new column headers on a imported cube, with support to cubes imported from OAuth source, and support idc behavior change flags
      java.lang.String getBinaryFileContent​(PostedFile fileInfo, int maxNumElements, boolean preserveWhiteSpace, java.lang.String outputDelimiter)
      get the contents from binary file
      java.lang.String getDIProjectSettings​(int settingID)
      get the Data import related project settings.
      WebElementSource getElementSource​(java.lang.String messageID)
      Returns a WebElementSource object which can be used to get elements within the working set of the given report.
      int getExecutionFlags()
      Returns the current setting for the execution flags, which will be used when submitting a report for execution to the Intelligence Server.
      int getExecutionFlagsExtension()
      Returns the current setting for the execution flags extension, which will be used when submitting a report for execution to the Intelligence Server.
      WebReportExportSettings getExportSettings​(int executionMode)
      Returns WebReportExportSettings which can be used to define the type of export and the various parameters for the export
      WebGraphProperties getGraphProperties()
      Return a WebGraphProperties object, which can be used to set the web graph properties.
      WebReportInstance getInstance​(java.lang.String messageID)
      Returns a WebReportInstance representing the report execution with the given message ID.
      WebReportInstance getInstance​(java.lang.String messageID, int stateID)
      Returns a WebReportInstance representing the report execution with the given message ID and state ID.
      WebReportInstance getInstanceFromHistoryList​(java.lang.String messageID)
      Returns a WebReportInstance representing the report execution with the given message ID.
      WebReportInstance getInstanceFromRWDrill​(RWDrill2ReportSettings drillSettings)
      Create a report instance based on the drill from a document.
      WebReportInstance getInstanceFromRWDrill​(RWDrill2ReportSettings drillSettings, int drillOption)
      Create a report instance based on the drill from a document/dossier (report editor)
      WebReportInstance getInstanceFromSchedule​(WebSchedule schedule)
      Deprecated.
      Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions.
      WebReportInstance getInstanceFromState​(SAXSupport parser, java.lang.String uri, java.lang.String local, java.lang.String qName, org.xml.sax.Attributes attrs)
      Create a report instance based on the pre-stored report state, which can be obtained by calling WebReportInstance.saveState().
      WebReportInstance getInstanceFromState​(java.lang.String savedStateStr)
      Create a report instance based on the pre-stored report state, which can be obtained by calling WebReportInstance.saveState().
      WebReportInstance getInstanceFromSubscription​(WebSubscription subscription)
      Create a report instance based on the subscription object.
      WebReportInstance getNewInstance()
      Generates a report instance by executing what is considered to be the "new report" report in metadata.
      WebReportInstance getNewInstance​(WebReportExecutionSettings settings)
      Generates a new report instance by executing the report with the given report ID, and returns the resultant WebReportInstance.
      WebReportInstance getNewInstance​(java.lang.String reportID)
      Generates a new report instance by executing the report with the given report ID, and returns the resultant WebReportInstance.
      WebReportInstance getNewInstanceEx​(java.lang.String reportID, java.lang.String extParams, int requestTimeout)
      Generates a new report instance by executing the report with the given report ID and extendable parameter, and returns the resultant WebReportInstance.
      WebReportInstance getNewInstanceFT​(java.lang.String filterID, java.lang.String templateID)
      Generates a new report instance by executing the given filter and template IDs as a report, and returning the resultant WebReportInstance.
      int getPreviewRows()
      Get the number of rows for preview.
      java.lang.String getPromptAnswer()
      Returns the prompt answer, if any, which will be used to pre-answer prompts when executing a new report.
      int getResultFlags()
      Returns the current setting for the result flags, which will be used when submitting a report for execution to the Intelligence Server or getting the results of a report.
      WebResultWindow getResultWindow()
      Returns a WebResultWindow object, which can be used to set the window of data that an execution or results retrieval will return.
      RWDrill2ReportSettings getRWDrill2ReportSettings()  
      java.lang.String getStyleID()
      Get the DSSID of the style on this report source, if the style was set by ID.
      java.lang.String getStyleName()
      Get the name of the style on this report, if the style was set by name.
      WebFilter getViewFilter()
      Get view filter from report source
      java.lang.String getViewSettings()
      Returns the current setting of the view settings XML, which will be sent to the Intelligence Server upon executing a report.
      WebReportInstance importCube​(PostedFile fileInfo, java.lang.String reportID)
      Create a cube on the IServer based on an imported file
      WebReportInstance importCube​(PostedFile fileInfo, java.lang.String reportID, java.lang.String documentID)
      Create a cube on the IServer based on an imported file
      WebReportInstance importCube​(PostedFile fileInfo, java.lang.String reportID, java.lang.String documentID, int behaviorFlags)
      Create a cube on the IServer based on an imported file, with support to idc import behavior change flags
      WebReportInstance importCube​(PostedFile fileInfo, java.lang.String msgID, java.lang.String tableID, java.lang.String reportID, java.lang.String documentID, int behaviorFlags)
      Create a cube on the IServer based on an imported file, with support to EMMA source table ID
      WebReportInstance importCube​(PostedFile fileInfo, java.lang.String msgID, java.lang.String tableID, java.lang.String reportID, java.lang.String documentID, java.lang.String numOfChunks, java.lang.String chunkSize, java.lang.String index, int behaviorFlags)
      Create a cube on the IServer based on an imported file, with support to EMMA source table ID.
      WebReportInstance importCube​(java.lang.String url, java.lang.String reportID)
      Create a cube on the IServer based on a file at the specified url
      WebReportInstance importCube​(java.lang.String reportID, java.lang.String documentID, int behaviorFlags, java.lang.String data)
      Create a cube on the IServer based on a file at the specified url, with support to idc import behavior change flags
      WebReportInstance importCube​(java.lang.String url, java.lang.String reportID, java.lang.String documentID)
      Create a cube on the IServer based on a file at the specified url
      WebReportInstance importCube​(java.lang.String url, java.lang.String reportID, java.lang.String documentID, int behaviorFlags)
      Create a cube on the IServer based on a file at the specified url, with support to idc import behavior change flags
      WebReportInstance importCube​(java.lang.String msgID, java.lang.String tableID, java.lang.String reportID, java.lang.String documentID, int behaviorFlags, java.lang.String data)
      Create a cube on the IServer based on an imported file, with support to EMMA source table ID
      WebReportInstance importCube​(java.lang.String url, java.lang.String msgID, java.lang.String tableID, java.lang.String reportID, java.lang.String documentID, int behaviorFlags)
      Create a cube on the IServer based on a file at the specified url, with support to msgID and tableID for EMMA cube
      WebReportInstance importCube​(java.lang.String msgID, java.lang.String tableID, java.lang.String reportID, java.lang.String documentID, java.lang.String numOfChunks, java.lang.String chunkSize, java.lang.String index, long fileSize, java.lang.String fileName, java.lang.String fileType, int behaviorFlags)
      Create a cube on the IServer based on an imported file, with support to EMMA source table ID.
      WebReportExecutionSettings newExecutionSettings()  
      WebReportInstance refresh​(java.lang.String messageID)
      Refresh the report instance specified by the message id and latest state.
      WebReportInstance refresh​(java.lang.String messageID, boolean reprompt)
      Refresh the report instance specified by the message id and latest state.
      WebReportInstance refresh​(java.lang.String messageID, int stateID)
      Refresh the report instance specified by the message id and state id.
      WebReportInstance refresh​(java.lang.String messageID, int stateID, boolean reprompt)
      Refresh the report instance specified by the message id and state id.
      java.lang.String setCubeMapping​(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 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 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
      void setExecutionFlags​(int executionFlags)
      Sets the execution flags, which will be used when submitting a report for execution to the Intelligence Server.
      void setExecutionFlagsExtension​(int executionFlagsExtension)
      Sets the execution flags extension, which will be used when submitting a report for execution to the Intelligence Server.
      void setLastExecutionMode​(int execMode)  
      void setPreviewRows​(int previewRows)
      Set the number of rows for preview.
      void setPromptAnswer​(java.lang.String promptAnswer)
      Sets a prompt answer which will be used to pre-answer any reports executed by this object.
      void setResultFlags​(int resultFlags)
      Sets the result flags, which will be used when submitting a report for execution to the Intelligence Server.
      void setStyleID​(java.lang.String styleID)
      Set a style by style DSSID.
      void setStyleName​(java.lang.String styleName)
      Set a style by style name.
      void setViewFilter​(WebFilter viewFilter)
      Set view filter to instance, which will be applied before running the report.
      void setViewSettings​(java.lang.String viewSettings)
      Sets the view settings XML, which will be sent to the Intelligence Server upon executing a report.
      java.lang.String uploadWallet​(PostedFile fileInfo, java.lang.String msgID, java.lang.String tableID, java.lang.String reportID, java.lang.String documentID, int behaviorFlags, java.lang.String did)
      Upload wallet file for parsing or save it to backend.

    • Method Detail

      • getNewInstance

        WebReportInstance getNewInstance​(java.lang.String reportID)
                          throws WebObjectsException
        Generates a new report instance by executing the report with the given report ID, and returns the resultant WebReportInstance.
        Parameters:
        reportID - The DSSID of the report to execute.
        Returns:
        A WebReportInstance object, representing the report executed by this method.
        Throws:
        WebObjectsException - Signals an error when executing the report.

      • getNewInstanceEx

        WebReportInstance getNewInstanceEx​(java.lang.String reportID,
                                   java.lang.String extParams,
                                   int requestTimeout)
                            throws WebObjectsException
        Generates a new report instance by executing the report with the given report ID and extendable parameter, and returns the resultant WebReportInstance.
        Parameters:
        reportID - The DSSID of the report to execute.
        extParams - extendable parameter when executing the report
        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:
        A WebReportInstance object, representing the report executed by this method.
        Throws:
        WebObjectsException - Signals an error when executing the report.

      • getNewInstanceFT

        WebReportInstance getNewInstanceFT​(java.lang.String filterID,
                                   java.lang.String templateID)
                            throws WebObjectsException
        Generates a new report instance by executing the given filter and template IDs as a report, and returning the resultant WebReportInstance.
        Parameters:
        filterID - The filter ID of the report to execute.
        templateID - The template ID of the report to execute.
        Returns:
        A WebReportInstance object, representing the report executed by this method.
        Throws:
        WebObjectsException - Signals an error when executing the report.

      • getInstance

        WebReportInstance getInstance​(java.lang.String messageID)
                       throws WebObjectsException
        Returns a WebReportInstance representing the report execution with the given message ID. Note that this does not cause a report execution to begin, but rather can be used to obtain the results of an already existing report instance.
        Parameters:
        messageID - The message ID of the job submitted to the Intelligence Server.
        Returns:
        A WebReportInstance object, representing the report with the given message ID.
        Throws:
        WebObjectsException - Thrown if the operation cannot be completed successfully.

      • getInstanceFromHistoryList

        WebReportInstance getInstanceFromHistoryList​(java.lang.String messageID)
                                      throws WebObjectsException
        Returns a WebReportInstance representing the report execution with the given message ID. Note that this does not cause a report execution to begin, but rather can be used to obtain the results of an already existing report instance.
        Parameters:
        messageID - The message ID of the job submitted to the Intelligence Server.
        Returns:
        A WebReportInstance object, representing the report with the given message ID.
        Throws:
        WebObjectsException - Thrown if the operation cannot be completed successfully.

      • getInstance

        WebReportInstance getInstance​(java.lang.String messageID,
                              int stateID)
                       throws WebObjectsException
        Returns a WebReportInstance representing the report execution with the given message ID and state ID. Note that this does not cause a report execution to begin, but rather can be used to obtain the results of an already existing report instance.
        Parameters:
        messageID - The message ID of the job submitted to the Intelligence Server.
        stateID - The state ID of the job submitted to the iIntelligence Server.
        Returns:
        A WebReportInstance object, representing the report with the given message ID.
        Throws:
        WebObjectsException - Thrown if the operation cannot be completed successfully.

      • getGraphProperties

        WebGraphProperties getGraphProperties()
        Return a WebGraphProperties object, which can be used to set the web graph properties. These properties will be passed as a parameter when a report is executed. First time call of this method will return a WebGraphProperties object with no property inside it. User can use the methods exposed by WebGraphProperties interface to add and manipulate the properties inside it. The other calls will return the current setting.
        Returns:
        Return a WebGraphProperties object to represent current settings of graph properties. First call will return an empty WebGraphProperties.

      • getExecutionFlags

        int getExecutionFlags()
        Returns the current setting for the execution flags, which will be used when submitting a report for execution to the Intelligence Server.
        Returns:
        The current execution flags, the bitwise or of values from EnumDSSXMLExecutionFlags.
        See Also:
        setExecutionFlags(int)

      • setExecutionFlags

        void setExecutionFlags​(int executionFlags)
        Sets the execution flags, which will be used when submitting a report for execution to the Intelligence Server.
        Parameters:
        executionFlags - The execution flags setting to use. This should be the bitwise or of values from EnumDSSXMLExecutionFlags.
        See Also:
        getExecutionFlags()

      • getExecutionFlagsExtension

        int getExecutionFlagsExtension()
        Returns the current setting for the execution flags extension, which will be used when submitting a report for execution to the Intelligence Server.
        Returns:
        The current execution flags extension, the bitwise or of values from EnumDSSXMLExecutionFlagsExtension.
        See Also:
        setExecutionFlagsExtension(int)

      • setExecutionFlagsExtension

        void setExecutionFlagsExtension​(int executionFlagsExtension)
        Sets the execution flags extension, which will be used when submitting a report for execution to the Intelligence Server.
        Parameters:
        executionFlagsExtension - The execution flags extension setting to use. This should be the bitwise or of values from EnumDSSXMLExecutionFlagsExtension.
        See Also:
        getExecutionFlagsExtension()

      • getResultFlags

        int getResultFlags()
        Returns the current setting for the result flags, which will be used when submitting a report for execution to the Intelligence Server or getting the results of a report.
        Returns:
        The current result flags, the bitwise or of values from EnumDSSXMLResultFlags.
        See Also:
        setResultFlags(int)

      • setResultFlags

        void setResultFlags​(int resultFlags)
        Sets the result flags, which will be used when submitting a report for execution to the Intelligence Server.
        Parameters:
        resultFlags - The result flags setting to use. This should be the bitwise or of values from EnumDSSXMLResultFlags.
        See Also:
        getResultFlags()

      • getViewSettings

        java.lang.String getViewSettings()
                          throws WebObjectsException
        Returns the current setting of the view settings XML, which will be sent to the Intelligence Server upon executing a report.
        Returns:
        The current setting of the view settings XML.
        Throws:
        WebObjectsException - Thrown when error in generating the current view setting.
        See Also:
        setViewSettings(java.lang.String)

      • setViewSettings

        void setViewSettings​(java.lang.String viewSettings)
              throws WebObjectsException
        Sets the view settings XML, which will be sent to the Intelligence Server upon executing a report.
        Parameters:
        viewSettings - The new value of the view settings XML.
        Throws:
        WebObjectsException - Thrown when the format of the input string is wrong.
        See Also:
        getViewSettings()

      • getPromptAnswer

        java.lang.String getPromptAnswer()
        Returns the prompt answer, if any, which will be used to pre-answer prompts when executing a new report.
        Returns:
        The current prompt answer which will be used when executing reports.
        See Also:
        setPromptAnswer(java.lang.String)

      • setPromptAnswer

        void setPromptAnswer​(java.lang.String promptAnswer)
        Sets a prompt answer which will be used to pre-answer any reports executed by this object.
        Parameters:
        promptAnswer - The value to pre-answer prompts with when executing reports via getNewInstance() or getNewInstanceFT().
        See Also:
        getPromptAnswer()

      • getResultWindow

        WebResultWindow getResultWindow()
        Returns a WebResultWindow object, which can be used to set the window of data that an execution or results retrieval will return.
        Returns:
        A WebResultWindow object, which can be edited to change the result window of the report.

      • getElementSource

        WebElementSource getElementSource​(java.lang.String messageID)
        Returns a WebElementSource object which can be used to get elements within the working set of the given report.
        Parameters:
        messageID - The message ID of the report instance of the working set that the elements will come from.
        Returns:
        A WebElementSource object set to return elements within the given report's working set.

      • setStyleID

        void setStyleID​(java.lang.String styleID)
        Set a style by style DSSID.
        Parameters:
        styleID - the DSSID of the style object to be applied.
        See Also:
        getStyleID()

      • setStyleName

        void setStyleName​(java.lang.String styleName)
        Set a style by style name.
        Parameters:
        styleName - the name of the style object to be applied.
        See Also:
        getStyleName()

      • getStyleID

        java.lang.String getStyleID()
        Get the DSSID of the style on this report source, if the style was set by ID.
        Returns:
        The DSSID of the style on this report source. null will be returned in two cases, when there is no style set for this report source, and when the style was set by Name. At the second case, you should use getStyleName() to check whether there is a style set by name.
        See Also:
        setStyleID(java.lang.String)

      • getStyleName

        java.lang.String getStyleName()
        Get the name of the style on this report, if the style was set by name.
        Returns:
        The name of the style on this report source. null will be returned in two cases, when there is no style set for this report source, and when the style was set by ID. At the second case, you should use getStyleID() to check whether there is a style set by ID.
        See Also:
        setStyleName(java.lang.String)

      • getPreviewRows

        int getPreviewRows()
        Get the number of rows for preview.
        Returns:
        the number of rows for preview.
        See Also:
        setPreviewRows(int)

      • setPreviewRows

        void setPreviewRows​(int previewRows)
        Set the number of rows for preview.
        Parameters:
        previewRows - The number of rows for preview.
        See Also:
        getPreviewRows()

      • refresh

        WebReportInstance refresh​(java.lang.String messageID)
                   throws WebObjectsException
        Refresh the report instance specified by the message id and latest state. This refresh will not reopen the answered prompt, if there is any. Dynamic reports (e.g. drilled reports) cannot be refreshed.
        Parameters:
        messageID - The message ID of the report instance to be refreshed.
        Returns:
        The refreshed WebReportInstance.
        Throws:
        WebObjectsException - Thrown when there is any error occurs during refresh process.

      • refresh

        WebReportInstance refresh​(java.lang.String messageID,
                          int stateID)
                   throws WebObjectsException
        Refresh the report instance specified by the message id and state id. This refresh will not reopen the answered prompt, if there is any. Dynamic reports (e.g. drilled reports) cannot be refreshed.
        Parameters:
        messageID - The message ID of the report instance to be refreshed.
        stateID - The state ID of the report instance to be refreshed.
        Returns:
        The refreshed WebReportInstance.
        Throws:
        WebObjectsException - Thrown when there is any error occurs during refresh process.

      • refresh

        WebReportInstance refresh​(java.lang.String messageID,
                          boolean reprompt)
                   throws WebObjectsException
        Refresh the report instance specified by the message id and latest state. If there is any prompt in this report, based on the reprompt parameter, this refresh will or will not reopen the answered prompt.
        Parameters:
        messageID - The message ID of the report instance to be refreshed.
        reprompt - When there is prompt in this report, if this is true, the refresh will reopen the prompt; if this is false, the refresh will use the original prompt answer.
        Returns:
        The refreshed WebReportInstance.
        Throws:
        WebObjectsException - Thrown when there is any error occurs during refresh process.

      • refresh

        WebReportInstance refresh​(java.lang.String messageID,
                          int stateID,
                          boolean reprompt)
                   throws WebObjectsException
        Refresh the report instance specified by the message id and state id. If there is any prompt in this report, based on the reprompt parameter, this refresh will or will not reopen the answered prompt.
        Parameters:
        messageID - The message ID of the report instance to be refreshed.
        stateID - The state ID of the report instance to be refreshed.
        reprompt - When there is prompt in this report, if this is true, the refresh will reopen the prompt; if this is false, the refresh will use the original prompt answer.
        Returns:
        The refreshed WebReportInstance.
        Throws:
        WebObjectsException - Thrown when there is any error occurs during refresh process.

      • getInstanceFromState

        WebReportInstance getInstanceFromState​(java.lang.String savedStateStr)
                                throws WebObjectsException
        Create a report instance based on the pre-stored report state, which can be obtained by calling WebReportInstance.saveState().
        Parameters:
        savedStateStr - The saved state of a report instance, which is obtained by calling WebReportInstance.saveState().
        Returns:
        WebReportInstance A report instance restored to state specified by the input parameter.
        Throws:
        WebObjectsException - Thrown when error ocurrs during create the report instance according to the input string.

      • getInstanceFromState

        WebReportInstance getInstanceFromState​(SAXSupport parser,
                                       java.lang.String uri,
                                       java.lang.String local,
                                       java.lang.String qName,
                                       org.xml.sax.Attributes attrs)
                                throws WebObjectsException
        Create a report instance based on the pre-stored report state, which can be obtained by calling WebReportInstance.saveState().
        Parameters:
        parser - SAX parser.
        uri - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
        local - The local name (without prefix), or the empty string if Namespace processing is not being performed.
        qName - The qualified name (with prefix), or the empty string if qualified names are not available. attrs The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object
        Returns:
        WebReportInstance A report instance restored to state specified by the input parameter.
        Throws:
        WebObjectsException - Thrown when error ocurrs during create the report instance according to the input.

      • getInstanceFromSchedule

        @Deprecated
WebReportInstance getInstanceFromSchedule​(WebSchedule schedule)
                                   throws WebObjectsException
        Deprecated.
        Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. Please use getInstanceFromSubscription(WebSubscription) instead.
        Create a report instance based on the schedule object. Thus, a report instance with the state similar to a scheduled report can be obtained using this method.
        Parameters:
        schedule - The schedule object.
        Returns:
        WebReportInstance A report instance built using the schedule information.
        Throws:
        WebObjectsException - Thrown when error ocurrs during creating the report instance

      • getInstanceFromSubscription

        WebReportInstance getInstanceFromSubscription​(WebSubscription subscription)
                                       throws WebObjectsException
        Create a report instance based on the subscription object. Thus, a report instance with the state similar to a subscribed report can be obtained using this method.
        Parameters:
        subscription - The subscription object.
        Returns:
        WebReportInstance A report instance built using the subscription information.
        Throws:
        WebObjectsException - Thrown when error occurs during creating the report instance

      • getInstanceFromRWDrill

        WebReportInstance getInstanceFromRWDrill​(RWDrill2ReportSettings drillSettings,
                                         int drillOption)
                                  throws WebObjectsException
        Create a report instance based on the drill from a document/dossier (report editor)
        Parameters:
        drillSettings - RWDrill2ReportSettings The drill parameters object.
        drillOption - EnumDSSXMLDrillOption server flag to determine which instance to return
        Returns:
        WebReportInstance A report instance built after the drill action.
        Throws:
        WebObjectsException
        WebObjectsException - Thrown when error occurs during creating the report instance
        Since:
        MicroStrategy Web 11.3.6

      • getInstanceFromRWDrill

        WebReportInstance getInstanceFromRWDrill​(RWDrill2ReportSettings drillSettings)
                                  throws WebObjectsException
        Create a report instance based on the drill from a document.
        Parameters:
        drillSettings - RWDrill2ReportSettings The drill parameters object.
        Returns:
        WebReportInstance A report instance built after the drill action.
        Throws:
        WebObjectsException
        WebObjectsException - Thrown when error occurs during creating the report instance
        Since:
        MicroStrategy Web 9.0.0

      • setLastExecutionMode

        void setLastExecutionMode​(int execMode)

      • importCube

        WebReportInstance importCube​(PostedFile fileInfo,
                             java.lang.String reportID,
                             java.lang.String documentID,
                             int behaviorFlags)
                      throws WebObjectsException
        Create a cube on the IServer based on an imported file, with support to idc import behavior change flags
        Parameters:
        fileInfo - PostedFile representing the file to be imported
        reportID - reportID for republish
        documentID - the document ID (used for mapping)
        behaviorFlags - idc behavior change flags 'fg'
        Returns:
        WebReportInstance of the cube created from the file
        Throws:
        WebObjectsException

      • importCube

        WebReportInstance importCube​(PostedFile fileInfo,
                             java.lang.String msgID,
                             java.lang.String tableID,
                             java.lang.String reportID,
                             java.lang.String documentID,
                             int behaviorFlags)
                      throws WebObjectsException
        Create a cube on the IServer based on an imported file, with support to EMMA source table ID
        Parameters:
        fileInfo - PostedFile representing the file to be imported
        msgID - message ID for EMMA cube
        tableID - source table ID for EMMA cube
        reportID - reportID for republish
        documentID - the document ID (used for mapping)
        behaviorFlags - idc behavior change flags 'fg'
        Returns:
        WebReportInstance of the cube created from the file
        Throws:
        WebObjectsException

      • importCube

        WebReportInstance importCube​(java.lang.String msgID,
                             java.lang.String tableID,
                             java.lang.String reportID,
                             java.lang.String documentID,
                             int behaviorFlags,
                             java.lang.String data)
                      throws WebObjectsException
        Create a cube on the IServer based on an imported file, with support to EMMA source table ID
        Parameters:
        msgID - message ID for EMMA cube
        tableID - source table ID for EMMA cube
        reportID - reportID for republish
        documentID - the document ID (used for mapping)
        behaviorFlags - idc behavior change flags 'fg'
        data - representing the contents of the file
        Returns:
        WebReportInstance of the cube created from the file
        Throws:
        WebObjectsException

      • importCube

        WebReportInstance importCube​(java.lang.String msgID,
                             java.lang.String tableID,
                             java.lang.String reportID,
                             java.lang.String documentID,
                             java.lang.String numOfChunks,
                             java.lang.String chunkSize,
                             java.lang.String index,
                             long fileSize,
                             java.lang.String fileName,
                             java.lang.String fileType,
                             int behaviorFlags)
                      throws WebObjectsException
        Create a cube on the IServer based on an imported file, with support to EMMA source table ID. Import the file by chunks.
        Parameters:
        msgID - message ID for EMMA cube
        tableID - source table ID for EMMA cube
        reportID - reportID for republish
        documentID - the document ID (used for mapping)
        numOfChunks - the total number of chunks the file split into
        chunkSize - the size of each chunk
        index - the index of each chunks
        fileSize - total size of the file
        fileName - name of the file
        fileType - type of the file
        behaviorFlags - idc behavior change flags 'fg'
        Returns:
        WebReportInstance of the cube created from the file
        Throws:
        WebObjectsException

      • importCube

        WebReportInstance importCube​(PostedFile fileInfo,
                             java.lang.String msgID,
                             java.lang.String tableID,
                             java.lang.String reportID,
                             java.lang.String documentID,
                             java.lang.String numOfChunks,
                             java.lang.String chunkSize,
                             java.lang.String index,
                             int behaviorFlags)
                      throws WebObjectsException
        Create a cube on the IServer based on an imported file, with support to EMMA source table ID. Import the file by chunks.
        Parameters:
        fileInfo - The PostedFile that represents the file.
        msgID - message ID for EMMA cube
        tableID - source table ID for EMMA cube
        reportID - reportID for republish
        documentID - the document ID (used for mapping)
        numOfChunks - the total number of chunks the file split into
        chunkSize - the size of each chunk
        index - the index of each chunks
        behaviorFlags - idc behavior change flags 'fg'
        Returns:
        WebReportInstance of the cube created from the file
        Throws:
        WebObjectsException

      • importCube

        WebReportInstance importCube​(java.lang.String url,
                             java.lang.String reportID)
                      throws WebObjectsException
        Create a cube on the IServer based on a file at the specified url
        Parameters:
        url - String containing location of the file used to create the new cube
        reportID - reportID for republish
        Returns:
        WebReportInstance of the cube created from the file at the specified location
        Throws:
        WebObjectsException

      • uploadWallet

        java.lang.String uploadWallet​(PostedFile fileInfo,
                              java.lang.String msgID,
                              java.lang.String tableID,
                              java.lang.String reportID,
                              java.lang.String documentID,
                              int behaviorFlags,
                              java.lang.String did)
                       throws WebObjectsException
        Upload wallet file for parsing or save it to backend.
        Parameters:
        fileInfo - The PostedFile that represents the file.
        msgID - message ID for EMMA cube
        tableID - source table ID for EMMA cube
        reportID - reportID for republish
        documentID - the document ID (used for mapping)
        behaviorFlags - behaviorFlags indicating purpose of uploading wallet file, 0: parsing, 1: save
        did - dbrole id.
        Returns:
        Throws:
        WebObjectsException

      • changeImportedCube

        WebReportInstance changeImportedCube​(int sheetIndex,
                                     java.lang.String colHeaders,
                                     java.lang.String reportID,
                                     java.lang.String msgID,
                                     boolean isUrl,
                                     java.lang.String transformations)
                              throws WebObjectsException
        Change the sheet index or insert new column headers on a imported cube
        Parameters:
        sheetIndex -
        colHeaders -
        reportID -
        msgID -
        Returns:
        Throws:
        WebObjectsException

      • changeImportedCube

        WebReportInstance changeImportedCube​(int sheetIndex,
                                     java.lang.String colHeaders,
                                     java.lang.String reportID,
                                     java.lang.String msgID,
                                     boolean isUrl,
                                     java.lang.String transformations,
                                     java.lang.String dbRoleID,
                                     java.lang.String sourceAccountID,
                                     int behaviorFlags)
                              throws WebObjectsException
        Change the sheet index or insert new column headers on a imported cube, with support to cubes imported from OAuth source, and support idc behavior change flags
        Parameters:
        sheetIndex -
        colHeaders -
        reportID -
        msgID -
        isUrl -
        transformations -
        dbRoleID -
        sourceAccountID -
        behaviorFlags -
        Returns:
        Throws:
        WebObjectsException

      • changeImportedCube

        WebReportInstance changeImportedCube​(int sheetIndex,
                                     java.lang.String colHeaders,
                                     java.lang.String reportID,
                                     java.lang.String msgID,
                                     boolean isUrl,
                                     java.lang.String transformations,
                                     java.lang.String dbRoleID,
                                     java.lang.String sourceAccountID,
                                     int behaviorFlags,
                                     java.lang.String documentID)
                              throws WebObjectsException
        Change the sheet index or insert new column headers on a imported cube, with support to cubes imported from OAuth source, and support idc behavior change flags
        Parameters:
        sheetIndex -
        colHeaders -
        reportID -
        msgID -
        isUrl -
        transformations -
        dbRoleID -
        sourceAccountID -
        behaviorFlags -
        documentID -
        Returns:
        Throws:
        WebObjectsException

      • importCube

        WebReportInstance importCube​(java.lang.String url,
                             java.lang.String reportID,
                             java.lang.String documentID)
                      throws WebObjectsException
        Create a cube on the IServer based on a file at the specified url
        Parameters:
        url - String containing location of the file used to create the new cube
        reportID - reportID for republish
        documentID - the document ID (used for mapping)
        Returns:
        WebReportInstance of the cube created from the file at the specified location
        Throws:
        WebObjectsException

      • importCube

        WebReportInstance importCube​(java.lang.String url,
                             java.lang.String reportID,
                             java.lang.String documentID,
                             int behaviorFlags)
                      throws WebObjectsException
        Create a cube on the IServer based on a file at the specified url, with support to idc import behavior change flags
        Parameters:
        url - String containing location of the file used to create the new cube
        reportID - reportID for republish
        documentID - the document ID (used for mapping)
        behaviorFlags - idc behavior change flags 'fg'
        Returns:
        WebReportInstance of the cube created from the file at the specified location
        Throws:
        WebObjectsException

      • importCube

        WebReportInstance importCube​(java.lang.String reportID,
                             java.lang.String documentID,
                             int behaviorFlags,
                             java.lang.String data)
                      throws WebObjectsException
        Create a cube on the IServer based on a file at the specified url, with support to idc import behavior change flags
        Parameters:
        reportID - reportID for republish
        documentID - the document ID (used for mapping)
        behaviorFlags - idc behavior change flags 'fg'
        data - String containing contents of file
        Returns:
        WebReportInstance of the cube created from the file at the specified location
        Throws:
        WebObjectsException

      • importCube

        WebReportInstance importCube​(java.lang.String url,
                             java.lang.String msgID,
                             java.lang.String tableID,
                             java.lang.String reportID,
                             java.lang.String documentID,
                             int behaviorFlags)
                      throws WebObjectsException
        Create a cube on the IServer based on a file at the specified url, with support to msgID and tableID for EMMA cube
        Parameters:
        url - String containing location of the file used to create the new cube
        msgID - EMMA cube msgID
        tableID - EMMA source table ID
        reportID - reportID for republish
        documentID - the document ID (used for mapping)
        behaviorFlags - idc behavior change flags 'fg'
        Returns:
        WebReportInstance of the cube created from the file at the specified location
        Throws:
        WebObjectsException

      • setCubeMapping

        java.lang.String setCubeMapping​(java.lang.String msgID,
                                java.lang.String mappingXML)
                         throws WebObjectsException
        Set the row/column to attribute/metric mapping for the specified imported cube
        Parameters:
        msgID - String containing the message id of the cube to be modified
        mappingXML - String containing the XML that IServer will use to modify the mapping
        Returns:
        String containing the message id of the modified report
        Throws:
        WebObjectsException

      • setCubeMapping

        java.lang.String setCubeMapping​(java.lang.String msgID,
                                java.lang.String mappingXML,
                                java.lang.String cubeRepublishBehavior)
                         throws WebObjectsException
        Set the row/column to attribute/metric mapping for the specified imported cube, with support to cube republishing behavior flag
        Parameters:
        msgID - String containing the message id of the cube to be modified
        mappingXML - String containing the XML that IServer will use to modify the mapping
        cubeRepublishBehavior - String containing the cube republishing behavior flag
        Returns:
        String containing the message id of the modified report
        Throws:
        WebObjectsException

      • setCubeMapping

        java.lang.String setCubeMapping​(java.lang.String msgID,
                                java.lang.String mappingXML,
                                java.lang.String cubeRepublishBehavior,
                                java.lang.String documentID)
                         throws WebObjectsException
        Set the row/column to attribute/metric mapping for the specified imported cube, with support to cube republishing behavior flag
        Parameters:
        msgID - String containing the message id of the cube to be modified
        mappingXML - String containing the XML that IServer will use to modify the 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 modified report
        Throws:
        WebObjectsException

      • getDIProjectSettings

        java.lang.String getDIProjectSettings​(int settingID)
                               throws WebObjectsException
        get the Data import related project settings.
        Parameters:
        settingID -
        Returns:
        String containing the value for the setting id.
        Throws:
        WebObjectsException

      • getBinaryFileContent

        java.lang.String getBinaryFileContent​(PostedFile fileInfo,
                                      int maxNumElements,
                                      boolean preserveWhiteSpace,
                                      java.lang.String outputDelimiter)
                               throws WebObjectsException
        get the contents from binary file
        Parameters:
        fileInfo - The PostedFile that represents the file.
        maxNumElements - the maximum number of elements to return
        preserveWhiteSpace - indicates if to strip off elements leading and trailing space
        outputDelimiter - output delimiter
        Returns:
        String formatted data from binary file
        Throws:
        WebObjectsException

      • setViewFilter

        void setViewFilter​(WebFilter viewFilter)
        Set view filter to instance, which will be applied before running the report.
        Parameters:
        viewFilter - WebFilterCustomGroupImpl

      • getViewFilter

        WebFilter getViewFilter()
        Get view filter from report source
        Returns: