Package com.microstrategy.webapi
Interface EnumDSSXMLExecutionFlags
-
public interface EnumDSSXMLExecutionFlags
This interface defines the enumeration constants used to specify the execution flags used to execute reports against the report server. Note that several flags must be used with other flags (for example,DssXmlExecutionUseCache
andDssXmlExecutionUpdateCache
must both be equal - if one is used, so must the other). Flags in this enumeration can affect caching (for example,DssXmlExecutionFresh
,DssXmlExecutionUseCache
andDssXmlExecutionUpdateCache
), the inbox status of the report (DssXmlExecutionInboxKeepAsIs
,DssXmlExecutionSaveToInbox
), can direct the Intelligence Server to only partially complete execution of the report (for example,DssXmlExecutionResolve
,DssXmlExecutionGenerateSQL
), and can control the information generated in the report(for example,DssXmlExecutionGenerateDatamart
). Please check the description of each setting below to determine the usage of each individual flag.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
Fields Modifier and Type Field Description static int
DssXmlExecutionCheckSQLPromp
Instructs report server to check for prompts in SQLstatic int
DssXmlExecutionCheckWebCache
Not implemented.static int
DssXmlExecutionDefault
The default execution flags, which includes DssXmlExecutionUseCache and DssXmlExecutionUpdateCache *static int
DssXmlExecutionDefaultPrompt
Specifies an execution flag which instructs the report server to answer every prompt with the default value stored in the prompt.static int
DssXmlExecutionDrillByManipulation
Reserved.static int
DssXmlExecutionExport
Specifies an execution flag which instructs the report server to execute for export results*static int
DssXmlExecutionFresh
Specifies an execution flag which instructs the report server not to use the cached information, even if available.static int
DssXmlExecutionGenerateDatamart
Specifies an execution flag which instructs the report server to generate a datamart from this report.static int
DssXmlExecutionGenerateSQL
This execution flag will cause execution to proceed up to the point that SQL is generated, but stop before submitting the SQL.static int
DssXmlExecutionInboxKeepAsIs
Specifies an execution flag which instructs the inbox to keep the result "as is" in the user inbox.static int
DssXmlExecutionNoAction
Specifies an execution flag which instructs the report server to execute without resolve prompts Only can be used at design modestatic int
DssXmlExecutionReBuildPreviewOnly
Specifies an execution flag which instructs the report server to only preview the rebuild.static int
DssXmlExecutionReprompt
Specifies an execution flag which instructs the report server to reprompt.static int
DssXmlExecutionResolve
Specifies an execution flag which instructs the report server to resolve the prompts in this report.static int
DssXmlExecutionSaveToInbox
Specifies an execution flag which instructs the inbox to save this report result to the user inbox and have the inbox keep the latest result.static int
DssXmlExecutionSubsetting
Specifies an execution flag which instructs the report server to perform subsetting when executing the report, if possible.static int
DssXmlExecutionUpdateCache
Specifies an execution flag which instructs the report server to update cache with the execution results.static int
DssXmlExecutionUseCache
Specifies an execution flag which instructs the report server to use cache if available.static int
DssXmlExecutionUseWebCacheOnly
Not implemented.static int
DssXmlExecutionWebQueryBuilderOrFFSQL
-
-
-
Field Detail
-
DssXmlExecutionFresh
static final int DssXmlExecutionFresh
Specifies an execution flag which instructs the report server not to use the cached information, even if available. This is incompatibile with DssXmlExecutionUseCache and DssXmlExecutionUpdateCache.- See Also:
- Constant Field Values
-
DssXmlExecutionDefaultPrompt
static final int DssXmlExecutionDefaultPrompt
Specifies an execution flag which instructs the report server to answer every prompt with the default value stored in the prompt.- See Also:
- Constant Field Values
-
DssXmlExecutionUseCache
static final int DssXmlExecutionUseCache
Specifies an execution flag which instructs the report server to use cache if available. If this is specified, then DssXmlExecutionUpdateCache must also be specified.- See Also:
- Constant Field Values
-
DssXmlExecutionUpdateCache
static final int DssXmlExecutionUpdateCache
Specifies an execution flag which instructs the report server to update cache with the execution results. If this is used, then DssXmlExecutionUseCache must also be used.- See Also:
- Constant Field Values
-
DssXmlExecutionInboxKeepAsIs
static final int DssXmlExecutionInboxKeepAsIs
Specifies an execution flag which instructs the inbox to keep the result "as is" in the user inbox.- See Also:
- Constant Field Values
-
DssXmlExecutionSaveToInbox
static final int DssXmlExecutionSaveToInbox
Specifies an execution flag which instructs the inbox to save this report result to the user inbox and have the inbox keep the latest result.- See Also:
- Constant Field Values
-
DssXmlExecutionReprompt
static final int DssXmlExecutionReprompt
Specifies an execution flag which instructs the report server to reprompt.- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
DssXmlExecutionCheckSQLPromp
static final int DssXmlExecutionCheckSQLPromp
Instructs report server to check for prompts in SQL- See Also:
- Constant Field Values
-
DssXmlExecutionResolve
static final int DssXmlExecutionResolve
Specifies an execution flag which instructs the report server to resolve the prompts in this report. Note that if this flag is set without the other flags correspoding to steps in the execution cycle, then the report will only be executed up to the point that prompts are resolved - after resolving prompts, the report execution will stop before running the SQL. This can be useful if something is to be done to the report before viewing the data.- See Also:
- Constant Field Values
-
DssXmlExecutionGenerateSQL
static final int DssXmlExecutionGenerateSQL
This execution flag will cause execution to proceed up to the point that SQL is generated, but stop before submitting the SQL. In this case, the report results cannot be retrieved, but other operations can be performed on the report.- See Also:
- Constant Field Values
-
DssXmlExecutionWebQueryBuilderOrFFSQL
static final int DssXmlExecutionWebQueryBuilderOrFFSQL
- See Also:
- Constant Field Values
-
DssXmlExecutionCheckWebCache
static final int DssXmlExecutionCheckWebCache
Not implemented.- See Also:
- Constant Field Values
-
DssXmlExecutionUseWebCacheOnly
static final int DssXmlExecutionUseWebCacheOnly
Not implemented.- See Also:
- Constant Field Values
-
DssXmlExecutionGenerateDatamart
static final int DssXmlExecutionGenerateDatamart
Specifies an execution flag which instructs the report server to generate a datamart from this report.- See Also:
- Constant Field Values
-
DssXmlExecutionSubsetting
static final int DssXmlExecutionSubsetting
Specifies an execution flag which instructs the report server to perform subsetting when executing the report, if possible.- See Also:
- Constant Field Values
-
DssXmlExecutionReBuildPreviewOnly
static final int DssXmlExecutionReBuildPreviewOnly
Specifies an execution flag which instructs the report server to only preview the rebuild.- See Also:
- Constant Field Values
-
DssXmlExecutionExport
static final int DssXmlExecutionExport
Specifies an execution flag which instructs the report server to execute for export results*- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
DssXmlExecutionDefault
static final int DssXmlExecutionDefault
The default execution flags, which includes DssXmlExecutionUseCache and DssXmlExecutionUpdateCache *- Since:
- MicroStrategy Web 7.5.1
- See Also:
- Constant Field Values
-
DssXmlExecutionNoAction
static final int DssXmlExecutionNoAction
Specifies an execution flag which instructs the report server to execute without resolve prompts Only can be used at design mode- Since:
- MicroStrategry Web 9.1.0
- See Also:
- Constant Field Values
-
DssXmlExecutionDrillByManipulation
static final int DssXmlExecutionDrillByManipulation
Reserved.- See Also:
- Constant Field Values
-
-