Package com.microstrategy.webapi

Interface EnumDSSXMLResultFlags

  • public interface EnumDSSXMLResultFlags
    This interface defines the enumeration constants used to specify the flags for retrieving report execution results.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Field Detail

      • DssXmlResultDtlsExprNothing

        static final int DssXmlResultDtlsExprNothing
        Reserved for future use
        See Also:
        Constant Field Values

      • DssXmlResultDtlsExprEmbedded

        static final int DssXmlResultDtlsExprEmbedded
        Reserved for future use
        See Also:
        Constant Field Values

      • DssXmlResultDtlsExprAll

        static final int DssXmlResultDtlsExprAll
        Reserved for future use
        See Also:
        Constant Field Values

      • DssXmlResultXmlSQL

        static final int DssXmlResultXmlSQL
        Specifies for retrieving report execution results a flag to include SQL.
        See Also:
        Constant Field Values

      • DssXmlResultDtlsTemplateLimit

        static final int DssXmlResultDtlsTemplateLimit
        Specifies the retrieval of the template limit.
        See Also:
        Constant Field Values

      • DssXmlResultDtlsTemplateUnits

        static final int DssXmlResultDtlsTemplateUnits
        Returns details about template units on the report
        See Also:
        Constant Field Values

      • DssXmlResultWorkingSet

        static final int DssXmlResultWorkingSet
        Get the working set XML for the subset report
        See Also:
        Constant Field Values

      • DssXmlResultNoDerivedPromptXML

        static final int DssXmlResultNoDerivedPromptXML
        Supresses derived list XML for prompt reports
        See Also:
        Constant Field Values

      • DssXmlResultDtlsFilterExpr

        static final int DssXmlResultDtlsFilterExpr
        See Also:
        Constant Field Values

      • DssXmlResultXmlDisplayProperties

        static final int DssXmlResultXmlDisplayProperties
        Specifies for retrieving report execution results a flag to include Web related properties.
        See Also:
        Constant Field Values

      • DssXmlResultNoResolution

        static final int DssXmlResultNoResolution
        Specifies for retrieving report execution results do not retrieve resolution.
        See Also:
        Constant Field Values

      • DssXmlResultGraph

        static final int DssXmlResultGraph
        Specifies for retrieving report execution results a flag to include graph related information.
        See Also:
        Constant Field Values

      • DssXmlResultFilter

        static final int DssXmlResultFilter
        Specifies for retrieving report execution results a flag to include filter details.
        See Also:
        Constant Field Values

      • DssXmlResultBandingAutoApply

        static final int DssXmlResultBandingAutoApply
        Specifies for retrieving report execution results a flag to automatically apply banding. When banding is turned on, repeated row headers are not merged. When banding is off, repeated row headers are merged. This particular flag informs the Intelligence Server to determine whether banding is on/off via the Template Formatting property MergeCells (-1 == on, 0 == off). This flag allows the banding style to be persisted as a report property. To force banding on/off, use DssXmlResultBandingStyle. This flag should not be used in conjunction with DssXmlResultBandingStyle - no guarantees can be made of the outcome.
        See Also:
        Constant Field Values

      • DssXmlResultRawData

        static final int DssXmlResultRawData
        Specifies for retrieving report execution results a flag to not format the report data.
        Since:
        MicroStrategy Web 7.5.0
        See Also:
        Constant Field Values

      • DssXmlResultDrillHigh

        static final int DssXmlResultDrillHigh
        Specifies for retrieving report execution results a flag to include the drill paths with high importance.
        See Also:
        Constant Field Values

      • DssXmlResultDrillMedium

        static final int DssXmlResultDrillMedium
        Specifies for retrieving report execution results a flag to include the drill paths with medium importance.
        See Also:
        Constant Field Values

      • DssXmlResultDrillLow

        static final int DssXmlResultDrillLow
        Specifies for retrieving report execution results a flag to include the drill paths with low importance.
        See Also:
        Constant Field Values

      • DssXmlResultGrid

        static final int DssXmlResultGrid
        Specifies for retrieving report execution results a flag to include the grid related information.
        See Also:
        Constant Field Values

      • DssXmlResultBandingStyle

        static final int DssXmlResultBandingStyle
        Specifies for retrieving report execution results a flag to generate the result XML in banding style. When banding style is set, repeated row headers are not merged (i.e. duplicates are rendered). When this flag is not set, repeated row headers are merged (denoted by a rowspan > 1).
        See Also:
        DssXmlResultBandingAutoApply, Constant Field Values

      • DssXmlResultFolderPath

        static final int DssXmlResultFolderPath
        Specifies for retrieving report execution results a flag to include the folder path of the report.
        See Also:
        Constant Field Values

      • DssXmlResultRelatedReports

        static final int DssXmlResultRelatedReports
        Specifies for retrieving report execution results a flag to include other reports in the same folder.
        See Also:
        Constant Field Values

      • DssXmlResultNoPageHeader

        static final int DssXmlResultNoPageHeader
        Specifies no page header when this is set.
        See Also:
        Constant Field Values

      • DssXmlResultMinimal

        static final int DssXmlResultMinimal
        Specifies to create minimal XML for prompt answer.
        See Also:
        Constant Field Values

      • DssXmlResultViewReport

        static final int DssXmlResultViewReport
        Specifies to return the template and view filter for the report in the report XML.
        See Also:
        Constant Field Values

      • DssXmlResultPutToInboxRead

        static final int DssXmlResultPutToInboxRead
        Specifies for retrieving report execution results a flag to put the report result into inbox in read status.
        See Also:
        Constant Field Values

      • DssXmlResultStatusOnlyIfNotReady

        static final int DssXmlResultStatusOnlyIfNotReady
        Specifies for retrieving report execution results a flag to not return any data unless the report is ready.
        See Also:
        Constant Field Values

      • DssXmlResultNoNumberFormating

        static final int DssXmlResultNoNumberFormating
        Specifies for retrieving report execution results a flag to return raw data without number formatting.
        See Also:
        Constant Field Values

      • DssXmlResultInboxMessage

        static final int DssXmlResultInboxMessage
        Specifies for retrieving report execution results a flag to include the inbox message information.
        See Also:
        Constant Field Values

      • DssXmlResultDefaultFormatProperties

        static final int DssXmlResultDefaultFormatProperties
        Specifies for retrieving report execution results a flag to get the default report format properties.
        See Also:
        Constant Field Values

      • DssXmlResultDatamartTableName

        static final int DssXmlResultDatamartTableName
        Specifies for retrieving report execution results a flag to write datamart table name to xml.
        See Also:
        Constant Field Values

      • DssXmlResultPreserve

        static final int DssXmlResultPreserve
        Specifies for retrieving report execution results a flag to preserve the result flags set previously (New flags are added to the existing result flags set if this flag is set, otherwise new flags replace the existing one).
        See Also:
        Constant Field Values

      • DssXmlResultPositiveFlags

        static final int DssXmlResultPositiveFlags
        All results
        See Also:
        Constant Field Values