Interface EnumPromptsBeanEvents
-
- All Known Implementing Classes:
AbstractPromptExpressionTransform
,AbstractPromptObjectTransform
,PromptCartTransform
,PromptCartXHTMLTransform
,PromptCheckboxTransform
,PromptConstantTransform
,PromptExpressionCartTransform
,PromptExpressionCartWithPickerTransform
,PromptExpressionCartXHTMLTransform
,PromptExpressionListTransform
,PromptExpressionNonCartTransform
,PromptExpressionTextboxTransform
,PromptHierarchicalCartTransform
,PromptHierarchicalCartXHTMLTransform
,PromptHierarchicalTreeTransform
,PromptHierarchicalTreeXHTMLTransform
,PromptListboxTransform
,PromptObjectBrowsingTransform
,PromptObjectBrowsingXHTMLTransform
,PromptRadioTransform
,PromptXSLTransform
public interface EnumPromptsBeanEvents
This interface defines all the IDs for prompt handling events and their arguments supported by the MicroStrategy SDK prompts event handler.Among the events, some are specific to a certain type of
WebPrompt
. For example, the eventPROMPTS_EVENT_HIGHLIGHT_DIMENSION_ATTRIBUTE
only applies to theWebExpressionPrompt
with expression type ofDssXmlFilterAllAttributeQual
.For users' convenience, events are broken down to small events targeted to each individual
PromptObject
contained in aPromptsBean
, but also there are two big events capable of handling all user actions supported by the prompts event handler. The mere difference between these two big eventsPROMPTS_EVENT_PROCESS_ALL_PROMPTS
andPROMPTS_EVENT_PROCESS_ANY_PROMPTS
is that the second event requires users to pass in the prompt positions of these PromptObject whose user actions need to be processed, while the first event automatically loops through all prompts.The prompts event handler allows users to specify prompt answer format as in
EnumPromptAnswerFormat
. This flag is especially useful in DHTML, where Javascript is enabled and clients are able to do light computation in client side. Also the prompt event handler provides flags as inEnumPromptAnswerOptions
to inform the event handler how to deal with null answer or empty answer passed in fromRequestKeys
.To specify a user action, merely pass in the corresponding action argument with its value equal to any non null string. It is the action argument's presence, rather than its value, that makes sense to the prompts event handler.
When passing objects or answer units through HTML to the event handler, a certain pre-defined format or rule must be conformed with. Otherwise, your input is unrecognizable to the prompts event handler and
WebException
should be thrown.Any
object
orelement
is actually adisplayUnit
, which is required to have three items:ID
,type
anddisplayName
, separated byITEM_SEPARATOR
in the listed order. Simple constant values are separated bySIMPLE_SEPARATOR_SEMICOLON
orSIMPLE_SEPARATOR_COMMA
. An answer unit is either a displayUnit or an expressionUnit as stated in the following rule in Backus-Naur Form (BNF) notation:answerUnits = answerUnit *(ANSWER_SEPARATOR answerUnit) answerUnit = expressionUnit | displayUnit | simpleValue expressionUnit = function EXPRESSION_SEPARATOR (shortcut | formShortcut) EXPRESSION_SEPARATOR values function = func ITEM_SEPARATOR funcType *(UNIT_SEPARATOR dimty) dimty = dimtyUnit *(UNIT_SEPARATOR dimtyUnit) dimtyUnit = dimtyID ITEM_SEPARATOR type ITEM_SEPARATOR displayName ITEM_SEPARATOR dimtyProperties dimtyID = ID | dimtyUnitType dimtyProperties = aggregation ITEM_SEPARATOR filtering ITEM_SEPARATOR groupBy ITEM_SEPARATOR relativePosition shortcut = displayUnit UNIT_SEPARATOR dataType formShortcut = attribute *1(UNIT_SEPERATOR attributeForm) UNIT_SEPARATOR dataType displayUnit = ID ITEM_SEPARATOR type ITEM_SEPARATOR displayName attribute = ID ITEM_SEPARATOR attrType ITEM_SEPARATOR displayName attributeForm = ID ITEM_SEPARATOR formType ITEM_SEPARATOR displayName values = simpleValues | elementList elementList = element *(UNIT_SEPARATOR element) element = ID ITEM_SEPARATOR elemType ITEM_SEPARATOR displayName simpleValues = simpleValue *(simpleSeparator simpleValue) simpleValue = any ASCII string without simpleSeparator simpleSeparator = SIMPLE_SEPARATOR_SEMICOLON | SIMPLE_SEPARATOR_COMMA dataType = any value from
EnumDSSXMLDataType
attrType =DssXmlTypeAttribute
formType =DssXmlTypeAttributeForm
elemType =WebDependentObjectElement
ID = 32-bit unique id type = displayUnitType- Since:
- MicroStrategy Web 7.3.1 or earlier
- See Also:
EnumPromptAnswerFormat
,EnumPromptAnswerOptions
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ANSWER_SEPARATOR
Specifies a separator to delimit two answer units in theflat
format.static java.lang.String
EXPRESSION_SEPARATOR
Specifies a separator to delimit expression elements within a expression answer unit forWebExpressionPrompt
in theflat
format.static java.lang.String
ITEM_SEPARATOR
Specifies a separator to delimit each item contained in the string representation of aWebDisplayUnit
.static java.lang.String
ITEM_SPECIAL_SEPARATOR
Specifies a separator to delimit each item contained in the string representation of aWebDisplayUnit
.static int
PROMPTS_EVENT_ADD_UNITS
Specifies an event to add new answer units to the existing answer of aPromptObject
contained in aPromptsBean
.static int
PROMPTS_EVENT_ANSWER_ALL_PROMPTS
Specifies an event to answer all thePromptObject
contained in aPromptsBean
.static int
PROMPTS_EVENT_ANSWER_ANY_PROMPTS
Specifies an event to answer any number ofPromptObject
contained in aPromptsBean
, but leave the rest untouched.static int
PROMPTS_EVENT_ANSWER_CONSTANT_PROMPT
Specifies an event to answer aWebConstantPrompt
at the specified prompt position in aPromptsBean
.static int
PROMPTS_EVENT_ANSWER_DIMTY_PROMPT
Specifies an event to answer aWebDimtyPrompt
at the specified prompt position in aPromptsBean
.static int
PROMPTS_EVENT_ANSWER_ELEMENTS_PROMPT
Specifies an event to answer aWebElementsPrompt
at the specified prompt position in aPromptsBean
.static int
PROMPTS_EVENT_ANSWER_EXPRESSION_PROMPT
Specifies an event to answer aWebExpressionPrompt
at the specified prompt position in aPromptsBean
.static int
PROMPTS_EVENT_ANSWER_OBJECTS_PROMPT
Specifies an event to answer aWebObjectsPrompt
at the specified prompt position in aPromptsBean
.static int
PROMPTS_EVENT_ANSWER_PROMPTS_IN_ADVANCE
static int
PROMPTS_EVENT_ARGUMENT_ACTION_ADD_UNITS
Specifies a user action to add more prompt answer units.static int
PROMPTS_EVENT_ARGUMENT_ACTION_ANSWER_PROMPT
Specifies a user action to answer a prompt.static int
PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_CHILD_FOLDER
Specifies a user action to browse a childWebFolder
.static int
PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_ELEMENT
static int
PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_PARENT_FOLDER
Specifies a user action to browse a parentWebFolder
.static int
PROMPTS_EVENT_ARGUMENT_ACTION_CANCEL_PROMPT
Specifies a user action to cancel answering a prompt.static int
PROMPTS_EVENT_ARGUMENT_ACTION_CLEAR_EXISTING_AND_ADD_UNITS
Specifies a user action to clear the exsiting prompt answers and then add new ones.static int
PROMPTS_EVENT_ARGUMENT_ACTION_DRILL_WITHIN_HIERARCHY
Specifies a user action to drill up and down within ahierarchy
in aWebExpressionPrompt
.static int
PROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION
Specifies a user action to highlight aWebDimension
.static int
PROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION_ATTRIBUTE
Specifies a user action to highlight aWebDimensionAttribute
in aWebExpressionPrompt
.static int
PROMPTS_EVENT_ARGUMENT_ACTION_INCREMENTAL_FETCH
Specifies a user action to incrementally fetchWebDisplayUnit
.static int
PROMPTS_EVENT_ARGUMENT_ACTION_REMOVE_UNITS
Specifies a user action to remove prompt answer units.static int
PROMPTS_EVENT_ARGUMENT_ACTION_SEARCH_BY_NAME
Specifies a user action to searchobjects
by their names.static int
PROMPTS_EVENT_ARGUMENT_ACTION_SHOW_SUMMARY
Specifies a user action to show the prompt summary.static int
PROMPTS_EVENT_ARGUMENT_ANSWER
Specifies an argument for the prompt answer units.static int
PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
Specifies an argument for the prompt answer format as inEnumPromptAnswerFormat
.static int
PROMPTS_EVENT_ARGUMENT_ANSWER_MODE_OPTION
An integer prompt answer mode fromEnumWebPromptAnswerMode
static int
PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS
Specifies an argument for answeroptions
when dealing with null or empty answer in theRequestKeys
.static int
PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID
Specifies an argument for aWebAttribute
or aWebDimensionAttribute
.static int
PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID_AND_FORM_ID
Specifies an argument for aWebAttribute
along with one of itsWebAttributeForm
, separated byUNIT_SEPARATOR
.static int
PROMPTS_EVENT_ARGUMENT_BLOCK_BEGIN
Specifies an argument for block begin for incremental fetch.static int
PROMPTS_EVENT_ARGUMENT_BLOCK_COUNT
Specifies an argument for block count for incremental fetch.static int
PROMPTS_EVENT_ARGUMENT_BROWSE_PATH
Specifies an argument for the browse path in element browsing.static int
PROMPTS_EVENT_ARGUMENT_CALENDAR_BUTTON
Specifies an argument to show the calendar button.static int
PROMPTS_EVENT_ARGUMENT_CHILD_FOLDER_ID
Specifies an argument for a childWebFolder
.static int
PROMPTS_EVENT_ARGUMENT_DIMENSION_ID
Specifies an argument for adimension
.static int
PROMPTS_EVENT_ARGUMENT_DO_NOT_AUTO_REPROMPT
Specifies an argument not to automatically re-open prompts in the Intelligence Server when all prompts are closed.static int
PROMPTS_EVENT_ARGUMENT_DRILL_TO_ATTRIBUTE_ID
Specifies an argument for the drilled-toWebAttribute
.static int
PROMPTS_EVENT_ARGUMENT_EXEC_FLAGS
static int
PROMPTS_EVENT_ARGUMENT_FILTER_STRING
Specifies an argument for a filter string used in element browsing.static int
PROMPTS_EVENT_ARGUMENT_FUNCTION
static int
PROMPTS_EVENT_ARGUMENT_HIDDEN_ATTRIBUTE_ID
Specifies an argument for a hidden variable in HTML to save the highlightedWebAttribute
orWebDimensionAttribute
.static int
PROMPTS_EVENT_ARGUMENT_HIDDEN_DIMENSION_ID
Specifies an argument for a hidden variable in HTML to save the highlightedWebDimension
.static int
PROMPTS_EVENT_ARGUMENT_INCREMENTAL_FETCH_GOTO_PAGE
Specifies an argument to go to a particular page for incrementally fetching objects and elements.static int
PROMPTS_EVENT_ARGUMENT_LINK_ANSWERS
static int
PROMPTS_EVENT_ARGUMENT_MATCH_CASE
Specifies an argument for case-sensitive when buildingWebFilter
.static int
PROMPTS_EVENT_ARGUMENT_MESSAGE_ALIAS
Option to rename the message of the resulting report or document.static int
PROMPTS_EVENT_ARGUMENT_METRIC_ID
Specifies an argument for aWebMetric
.static int
PROMPTS_EVENT_ARGUMENT_NAVIGATION
Specifies an argument for navigating through aPromptsBean
.static int
PROMPTS_EVENT_ARGUMENT_OBJECT_TYPE
Specifies an argument describing an object type that is relevant to an event.static int
PROMPTS_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID
Specifies an argument for the original RW document message ID.static int
PROMPTS_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML
Specifies an argument for the prompt answers used in the original RW instance.static int
PROMPTS_EVENT_ARGUMENT_PARENT_FOLDER_ID
Specifies an argument for a parentWebFolder
.static int
PROMPTS_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER
Specifies an argument for the prompt answers to theWebElementsPrompt
contained in the destination instance.static int
PROMPTS_EVENT_ARGUMENT_PLAIN_OBJECT_PROMPT_ANSWER
static int
PROMPTS_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER
static int
PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION
Specifies an argument for prompt position, a non negative integer.static int
PROMPTS_EVENT_ARGUMENT_REOPEN_PROMPT
Speicifies an argument to re-open a closed prompt in Web.static int
PROMPTS_EVENT_ARGUMENT_SAP_VARIABLE_EXCLUDE
Specifies an argument to indicate anEXCLUDE
sub-expression in the prompt answer for supporting SAP Variables.static int
PROMPTS_EVENT_ARGUMENT_SEARCH_NAME
Specifies an argument for the searching name.static int
PROMPTS_EVENT_ARGUMENT_SEARCH_ROOT
Specifies an argument for the searchingroot
.static int
PROMPTS_EVENT_ARGUMENT_SRC_ANSWERS
static int
PROMPTS_EVENT_ARGUMENT_SUB_ROOT_OPERATOR
static int
PROMPTS_EVENT_ARGUMENT_SUBMIT_ANSWER
Specifies an argument to submit the prompt answer.static int
PROMPTS_EVENT_ARGUMENT_UNITS_TO_ADD
Specifies an argument for the prompt answer units to add.static int
PROMPTS_EVENT_ARGUMENT_UNITS_TO_REMOVE
Specifies an argument for the prompt answer units to remove.static int
PROMPTS_EVENT_ARGUMENT_USE_SET_ANSWERS
The argument for the Answer all prompts to indicate that we should use the already set answers saved on the prompt beans effectively ignoring the other argumentsPROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS
,PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
.static int
PROMPTS_EVENT_ARGUMENT_USER_SEPARATOR
Specifies an argument for user specified string separator.static int
PROMPTS_EVENT_BROWSE_DIMENSION_ATTRIBUTE_ELEMENTS
Specifies an event to browse elements of a dimension attribute for aPromptObject
contained in aPromptsBean
.static int
PROMPTS_EVENT_BROWSE_ELEMENTS
Specifies an event to browseWebElement
of aWebAttribute
for aPromptObject
contained in aPromptsBean
.static int
PROMPTS_EVENT_BROWSE_HIERARCHICAL_CHILD_FOLDER
Specifies an event to browse the content of a childWebFolder
of the current folder for aPromptObject
contained in aPromptsBean
.static int
PROMPTS_EVENT_BROWSE_HIERARCHICAL_PARENT_FOLDER
Specifies an event to browse the content of a parentWebFolder
of the current folder for aPromptObject
contained in aPromptsBean
.static int
PROMPTS_EVENT_CANCEL_ALL_PROMPTS
Specifies an event to cancel answering allPromptObject
contained in aPromptsBean
.static int
PROMPTS_EVENT_CANCEL_ANY_PROMPTS
Specifies an event to cancel answering any number ofPromptObject
contained in aPromptsBean
.static int
PROMPTS_EVENT_CLEAR_EXISTING_AND_ADD_UNITS
Specifies an event to clear existing prompt answer and add new answer units to aPromptObject
contained in aPromptsBean
.static int
PROMPTS_EVENT_CLEAR_HIERARCHICAL_SEARCH_EXPRESSION
Specifies an event to clear the user search expression for aPromptObject
contained in aPromptsBean
.static int
PROMPTS_EVENT_DRILL_WITHIN_HIERARCHY
Specifies an event to drill to aWebDimensionAttribute
up and down within ahierarchy
for aPromptObject
contained in aPromptsBean
.static int
PROMPTS_EVENT_HIGHLIGHT_DIMENSION
static int
PROMPTS_EVENT_HIGHLIGHT_DIMENSION_ATTRIBUTE
Specifies an event to highlight aWebDimensionAttribute
in ahierarchy
for aPromptObject
contained in aPromptsBean
.static int
PROMPTS_EVENT_INCREMENTAL_FETCH
static int
PROMPTS_EVENT_NAVIGATE_PROMPTS_BEAN
Specifies an event to navigate through allPromptObject
contained in aPromptsBean
.static int
PROMPTS_EVENT_PROCESS_ALL_PROMPTS
Specifies an event to process any supported user action for allPromptObject
contained in aPromptsBean
.static int
PROMPTS_EVENT_PROCESS_ANY_PROMPTS
Specifies an event to process any supported user action for any number ofPromptObject
contained in aPromptsBean
.static int
PROMPTS_EVENT_REMOVE_UNITS
Specifies an event to remove answer units from aPromptObject
contained in aPromptsBean
.static int
PROMPTS_EVENT_SEARCH_BY_NAME
Specifies an event to searchobjects
by specifying the searching name for aPromptObject
contained in aPromptsBean
.static int
PROMPTS_EVENT_SHOW_ALL_PROMPTS_SUMMARY
Specifies an event to show summary of allPromptObject
contained in aPromptsBean
.static int
PROMPTS_EVENT_SHOW_ANY_PROMPTS_SUMMARY
Specifies an event to show summary of any number ofPromptObject
contained in aPromptsBean
.static java.lang.String
SIMPLE_SEPARATOR_CARET
Specifies a simple separator to delimit an element ID and its element display name in the URL prompt answer forWebElementsPrompt
.static java.lang.String
SIMPLE_SEPARATOR_COMMA
Specifies a simple separator to delimit two string constant values.static java.lang.String
SIMPLE_SEPARATOR_SEMICOLON
Specifies a simple separator to delimit two string constant values.static java.lang.String
UNIT_SEPARATOR
Specifies a separator to delimit twoWebDisplayUnit
, each of which is represented as a string concatenation of ID, type, and displayName.
-
-
-
Field Detail
-
PROMPTS_EVENT_ANSWER_ALL_PROMPTS
static final int PROMPTS_EVENT_ANSWER_ALL_PROMPTS
Specifies an event to answer all thePromptObject
contained in aPromptsBean
.This event needs the following optional arguments:
- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ANSWER_ANY_PROMPTS
static final int PROMPTS_EVENT_ANSWER_ANY_PROMPTS
Specifies an event to answer any number ofPromptObject
contained in aPromptsBean
, but leave the rest untouched. This event requires users to specify the prompt positions at which the corresponding PromptObject are going to be answered.This event needs the following required arguments:
and the following optional arguments:- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ANSWER_CONSTANT_PROMPT
static final int PROMPTS_EVENT_ANSWER_CONSTANT_PROMPT
Specifies an event to answer aWebConstantPrompt
at the specified prompt position in aPromptsBean
.This event needs the following required arguments:
and the following optional arguments:- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ANSWER_OBJECTS_PROMPT
static final int PROMPTS_EVENT_ANSWER_OBJECTS_PROMPT
Specifies an event to answer aWebObjectsPrompt
at the specified prompt position in aPromptsBean
.This event needs the following required arguments:
and the following optional arguments:- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ANSWER_DIMTY_PROMPT
static final int PROMPTS_EVENT_ANSWER_DIMTY_PROMPT
Specifies an event to answer aWebDimtyPrompt
at the specified prompt position in aPromptsBean
.This event needs the following required arguments:
and the following optional arguments:- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ANSWER_ELEMENTS_PROMPT
static final int PROMPTS_EVENT_ANSWER_ELEMENTS_PROMPT
Specifies an event to answer aWebElementsPrompt
at the specified prompt position in aPromptsBean
.This event needs the following required arguments:
and the following optional arguments:- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ANSWER_EXPRESSION_PROMPT
static final int PROMPTS_EVENT_ANSWER_EXPRESSION_PROMPT
Specifies an event to answer aWebExpressionPrompt
at the specified prompt position in aPromptsBean
.This event needs the following required arguments:
and the following optional arguments:- See Also:
- Constant Field Values
-
PROMPTS_EVENT_PROCESS_ALL_PROMPTS
static final int PROMPTS_EVENT_PROCESS_ALL_PROMPTS
Specifies an event to process any supported user action for allPromptObject
contained in aPromptsBean
.This event does not need the prompt position argument, since it automatically loops through all PromptObject no matter whether the user has performed any action on it.
When looping through the PromptsBean and processing each individual PromptObject, this event looks for any user action supported by the event handler, and then executes the action before it stops processing. Changes to the prompt answer is always checked and processed even though there is no action specified. User action argument, which informs the event what arguments to look for and what to do, has the prefix
PROMPTS_EVENT_ARGUMENT_ACTION_
to distinguish from other event arguments.With no surprise, this event includes almost all the event arguments defined in this interface. Depending on action, users can pass in any partial arguments necessary for this particular action. As a hint to what arguments are necessary, look for those defined in the corresponding smaller event. For example, if the user action is to incrementally fetch objects as specified by the action argument
PROMPTS_EVENT_ARGUMENT_ACTION_INCREMENTAL_FETCH
, look for those arguments defined in the corresponding smaller eventPROMPTS_EVENT_INCREMENTAL_FETCH
. Since changes to prompt answer is always processed, the user is free to pass in new prompt answer along with those incremental fetch arguments, i.e.blockBegin
,blockCount
.Although all arguments are optional for the whole event due to supporting of multiple actions within the same event, some of them are really required arguments for a particular action. For example, the event argument
PROMPTS_EVENT_ARGUMENT_DIMENSION_ID
is a required argument for the user actionPROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION
.This event needs the following optional arguments:
PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID
PROMPTS_EVENT_ARGUMENT_FILTER_STRING
PROMPTS_EVENT_ARGUMENT_BLOCK_BEGIN
PROMPTS_EVENT_ARGUMENT_BLOCK_COUNT
PROMPTS_EVENT_ARGUMENT_SEARCH_NAME
PROMPTS_EVENT_ARGUMENT_SEARCH_ROOT
PROMPTS_EVENT_ARGUMENT_ACTION_ADD_UNITS
PROMPTS_EVENT_ARGUMENT_ACTION_REMOVE_UNITS
PROMPTS_EVENT_ARGUMENT_ACTION_CANCEL_PROMPT
PROMPTS_EVENT_ARGUMENT_ACTION_ANSWER_PROMPT
PROMPTS_EVENT_ARGUMENT_ACTION_SEARCH_BY_NAME
PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_ELEMENT
PROMPTS_EVENT_ARGUMENT_ANSWER
PROMPTS_EVENT_ARGUMENT_UNITS_TO_ADD
PROMPTS_EVENT_ARGUMENT_UNITS_TO_REMOVE
PROMPTS_EVENT_ARGUMENT_SUB_ROOT_OPERATOR
PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
PROMPTS_EVENT_ARGUMENT_DIMENSION_ID
PROMPTS_EVENT_ARGUMENT_ACTION_DRILL_WITHIN_HIERARCHY
PROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION_ATTRIBUTE
PROMPTS_EVENT_ARGUMENT_FUNCTION
PROMPTS_EVENT_ARGUMENT_METRIC_ID
PROMPTS_EVENT_ARGUMENT_PARENT_FOLDER_ID
PROMPTS_EVENT_ARGUMENT_CHILD_FOLDER_ID
PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_CHILD_FOLDER
PROMPTS_EVENT_ARGUMENT_DRILL_TO_ATTRIBUTE_ID
PROMPTS_EVENT_ARGUMENT_ACTION_CLEAR_EXISTING_AND_ADD_UNITS
PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID_AND_FORM_ID
PROMPTS_EVENT_ARGUMENT_NAVIGATION
PROMPTS_EVENT_ARGUMENT_ACTION_INCREMENTAL_FETCH
PROMPTS_EVENT_ARGUMENT_MATCH_CASE
PROMPTS_EVENT_ARGUMENT_ACTION_SHOW_SUMMARY
PROMPTS_EVENT_ARGUMENT_CALENDAR_BUTTON
PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS
PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_PARENT_FOLDER
PROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION
- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ADD_UNITS
static final int PROMPTS_EVENT_ADD_UNITS
Specifies an event to add new answer units to the existing answer of aPromptObject
contained in aPromptsBean
.This event applies to all types of WebPrompt but each type of prompt has different answer unit. For example, the answer unit for a
WebConstantPrompt
would be a single string; for aWebExpressionPrompt
, its answer unit is a sub expression constituting of aWebOperatorNode
and one or more operands, each of which is aWebNode
in general. Therefore, for different type of WebPrompt, users need to pass in different arguments to constitute a valid prompt answer unit.The argument
PROMPTS_EVENT_ARGUMENT_UNITS_TO_ADD
holds different items for different type of WebPrompt. ForWebObjectsPrompt
, it holds a list ofobjects
; forWebElementsPrompt
, it holds a list ofelements
; forWebExpressionPrompt
, it holds a list of constant string values for constituting an answer unit, which is a sub expression.When adding new answer units, this event also allows the users to change the function of root
WebOperatorNode
to eitherDssXmlFunctionAnd
orDssXmlFunctionOr
.This event needs the following required arguments:
and the following optional arguments:- See Also:
PROMPTS_EVENT_REMOVE_UNITS
, Constant Field Values
-
PROMPTS_EVENT_REMOVE_UNITS
static final int PROMPTS_EVENT_REMOVE_UNITS
Specifies an event to remove answer units from aPromptObject
contained in aPromptsBean
.This event applies to all types of
WebPrompt
. The argumentPROMPTS_EVENT_ARGUMENT_UNITS_TO_REMOVE
holds the key, an integer number, of the answer unit to be removed.To remove a
WebElement
from aWebElementsObjectNode
, users need to pass in the keys for both objects, separated by theITEM_SEPARATOR
.Same as the event
PROMPTS_EVENT_ADD_UNITS
, when removing units from prompt answer, this event also allows the users to change the function of rootWebOperatorNode
to eitherDssXmlFunctionAnd
orDssXmlFunctionOr
.This event needs the following required arguments:
and the following optional arguments:- See Also:
PROMPTS_EVENT_ADD_UNITS
, Constant Field Values
-
PROMPTS_EVENT_CANCEL_ANY_PROMPTS
static final int PROMPTS_EVENT_CANCEL_ANY_PROMPTS
Specifies an event to cancel answering any number ofPromptObject
contained in aPromptsBean
.Validation error
is thrown if it is a required prompt.This event needs the following required arguments:
-
PROMPTS_EVENT_CANCEL_ALL_PROMPTS
static final int PROMPTS_EVENT_CANCEL_ALL_PROMPTS
Specifies an event to cancel answering allPromptObject
contained in aPromptsBean
.Validation error
is thrown if it is a required prompt.This event needs no required or optional arguments.
-
PROMPTS_EVENT_BROWSE_ELEMENTS
static final int PROMPTS_EVENT_BROWSE_ELEMENTS
Specifies an event to browseWebElement
of aWebAttribute
for aPromptObject
contained in aPromptsBean
.This event applies only to
WebElementsPrompt
orWebExpressionPrompt
with its expression type equal toDssXmlFilterAllAttributeQual
. For WebElementsPrompt, since its origin is a single WebAttribute, no attribute needs to be specified in theRequestKeys
; but for WebExpressionPrompt, it requires to pass in both theWebDimension
object and its belongingWebDimensionAttribute
object to make things clear.When building
WebFilter
for filtered element browsing, certain rules are applied when parsing the filter string a user types in on Web browser. In Backus-Naur Form (BNF) notation, the rule can be stated as (starting and trailing whitespace characters are trimed before parsing): Any non-null value for theFilterString = Segment 1*(AndOperator Segment) | Segment 1*(OrOperator Segment) | "NOT" Segment | Segment AndOperator = "AND" | "and" | "|" OrOperator = "OR" | "or" | "," Segment = Literal | NormalString Literal = """ NormalString """ NormalString = any ASCII character string excluding double quotes
PROMPTS_EVENT_ARGUMENT_MATCH_CASE
argument means case-sensitive when building the filter.To make it useful in DHTML mode where Javascript could be used, this event also processes prompt answers while browsing elements. It is totally reasonable that a user first moves the prompt answer around by using Javascript, and then starts element browsing; it would be unacceptable to the users if the event loses prompt answer changes after finishing element browsing.
This event needs the following required arguments:
and the following optional arguments:PROMPTS_EVENT_ARGUMENT_BLOCK_BEGIN
PROMPTS_EVENT_ARGUMENT_BLOCK_COUNT
PROMPTS_EVENT_ARGUMENT_FILTER_STRING
PROMPTS_EVENT_ARGUMENT_HIDDEN_DIMENSION_ID
PROMPTS_EVENT_ARGUMENT_HIDDEN_ATTRIBUTE_ID
PROMPTS_EVENT_ARGUMENT_MATCH_CASE
PROMPTS_EVENT_ARGUMENT_ANSWER
PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS
- See Also:
- Constant Field Values
-
PROMPTS_EVENT_SEARCH_BY_NAME
static final int PROMPTS_EVENT_SEARCH_BY_NAME
Specifies an event to searchobjects
by specifying the searching name for aPromptObject
contained in aPromptsBean
.This event applies only to
WebObjectsPrompt
orWebDimtyPrompt
. To make it useful in DHTML mode where Javascript could be used, this event also processes prompt answers while searching objects. It is totally reasonable that a user first moves the prompt answer around by using Javascript, and then starts searching; it would be unacceptable to the user if the event loses prompt answer changes after finishing searching.This event needs the following required arguments:
and the following optional arguments:- See Also:
- Constant Field Values
-
PROMPTS_EVENT_PROCESS_ANY_PROMPTS
static final int PROMPTS_EVENT_PROCESS_ANY_PROMPTS
Specifies an event to process any supported user action for any number ofPromptObject
contained in aPromptsBean
.This event does exactly the same thing as another event
PROMPTS_EVENT_PROCESS_ALL_PROMPTS
, except that this event requires prompt positions and only processes those PromptObject whose positions are specified in theRequestKeys
.When processing each individual PromptObject whose position is specified, this event looks for any user action supported by the event handler, and then executes the action before it stops processing. Changes to the prompt answer is always checked and processed even though there is no action specified. User action argument, which informs the event what arguments to look for and what to do, has the prefix
PROMPTS_EVENT_ARGUMENT_ACTION_
to distinguish from other event arguments.With no surprise, this event includes almost all the event arguments defined in this interface. Depending on action, users can pass in any partial arguments necessary for this particular action. As a hint to what arguments are necessary, look for those defined in the corresponding smaller event. For example, if the user action is to incrementally fetch objects as specified by the action argument
PROMPTS_EVENT_ARGUMENT_ACTION_INCREMENTAL_FETCH
, look for those arguments defined in the corresponding smaller eventPROMPTS_EVENT_INCREMENTAL_FETCH
. Since changes to prompt answer is always processed, the user is free to pass in new prompt answer along with those incremental fetch arguments, i.e.blockBegin
,blockCount
.Although all arguments are optional for the whole event due to supporting of multiple actions within the same event, some of them are really required arguments for a particular action. For example, the event argument
PROMPTS_EVENT_ARGUMENT_DIMENSION_ID
is a required argument for the user actionPROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION
.This event needs the following required arguments:
and the following optional arguments:PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID
PROMPTS_EVENT_ARGUMENT_FILTER_STRING
PROMPTS_EVENT_ARGUMENT_BLOCK_BEGIN
PROMPTS_EVENT_ARGUMENT_BLOCK_COUNT
PROMPTS_EVENT_ARGUMENT_SEARCH_NAME
PROMPTS_EVENT_ARGUMENT_SEARCH_ROOT
PROMPTS_EVENT_ARGUMENT_ACTION_ADD_UNITS
PROMPTS_EVENT_ARGUMENT_ACTION_REMOVE_UNITS
PROMPTS_EVENT_ARGUMENT_ACTION_CANCEL_PROMPT
PROMPTS_EVENT_ARGUMENT_ACTION_ANSWER_PROMPT
PROMPTS_EVENT_ARGUMENT_ACTION_SEARCH_BY_NAME
PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_ELEMENT
PROMPTS_EVENT_ARGUMENT_ANSWER
PROMPTS_EVENT_ARGUMENT_UNITS_TO_ADD
PROMPTS_EVENT_ARGUMENT_UNITS_TO_REMOVE
PROMPTS_EVENT_ARGUMENT_SUB_ROOT_OPERATOR
PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
PROMPTS_EVENT_ARGUMENT_DIMENSION_ID
PROMPTS_EVENT_ARGUMENT_ACTION_DRILL_WITHIN_HIERARCHY
PROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION_ATTRIBUTE
PROMPTS_EVENT_ARGUMENT_FUNCTION
PROMPTS_EVENT_ARGUMENT_METRIC_ID
PROMPTS_EVENT_ARGUMENT_PARENT_FOLDER_ID
PROMPTS_EVENT_ARGUMENT_CHILD_FOLDER_ID
PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_CHILD_FOLDER
PROMPTS_EVENT_ARGUMENT_DRILL_TO_ATTRIBUTE_ID
PROMPTS_EVENT_ARGUMENT_ACTION_CLEAR_EXISTING_AND_ADD_UNITS
PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID_AND_FORM_ID
PROMPTS_EVENT_ARGUMENT_NAVIGATION
PROMPTS_EVENT_ARGUMENT_ACTION_INCREMENTAL_FETCH
PROMPTS_EVENT_ARGUMENT_MATCH_CASE
PROMPTS_EVENT_ARGUMENT_ACTION_SHOW_SUMMARY
PROMPTS_EVENT_ARGUMENT_CALENDAR_BUTTON
PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS
PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_PARENT_FOLDER
PROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION
-
PROMPTS_EVENT_DRILL_WITHIN_HIERARCHY
static final int PROMPTS_EVENT_DRILL_WITHIN_HIERARCHY
Specifies an event to drill to aWebDimensionAttribute
up and down within ahierarchy
for aPromptObject
contained in aPromptsBean
.This event applies only to
WebExpressionPrompt
with its expression type equal toDssXmlFilterAllAttributeQual
. To make it useful in DHTML mode where Javascript could be used, this event also processes prompt answers while drilling. It is totally reasonable that a user first moves the prompt answer around by using Javascript, and then starts drilling; it would be unacceptable to the user if the event loses prompt answer changes after finishing drilling.When drilling down within the hierarchy, this event requires users to specify a list of
WebElement
from where to drill down Or specify the browse path of that attribute. If the browse path argument is specified, the element list is ignored and the drilling is based on the browse path only. In drilling up, there is no such a requirement. The argumentPROMPTS_EVENT_ARGUMENT_UNITS_TO_ADD
can be used for passing the list ofWebElement
.This event needs the following required arguments:
and the following optional arguments:- See Also:
- Constant Field Values
-
PROMPTS_EVENT_HIGHLIGHT_DIMENSION_ATTRIBUTE
static final int PROMPTS_EVENT_HIGHLIGHT_DIMENSION_ATTRIBUTE
Specifies an event to highlight aWebDimensionAttribute
in ahierarchy
for aPromptObject
contained in aPromptsBean
.This event applies only to
WebExpressionPrompt
with its expression type equal toDssXmlFilterAllAttributeQual
. To make it useful in DHTML mode where Javascript could be used, this event also processes prompt answers while highlighting. It is totally reasonable that a user first moves the prompt answer around by using Javascript, and then starts highlighting; it would be unacceptable to the user if the event loses prompt answer changes after finishing highlighting.This event needs the following required arguments:
and the following optional arguments:- See Also:
- Constant Field Values
-
PROMPTS_EVENT_BROWSE_HIERARCHICAL_CHILD_FOLDER
static final int PROMPTS_EVENT_BROWSE_HIERARCHICAL_CHILD_FOLDER
Specifies an event to browse the content of a childWebFolder
of the current folder for aPromptObject
contained in aPromptsBean
.This event applies only to
WebObjectsPrompt
,WebDimtyPrompt
orWebExpressionPrompt
when their origins are aWebSearch
object. In fact, the content of the folder to browse is brought back by searching in the project, and this event just changes the searching root on the origin, a WebSearch object.To make it useful in DHTML mode where Javascript could be used, this event also processes prompt answers while browsing folder contents. It is totally reasonable that a user first moves the prompt answer around by using Javascript, and then starts browsing; it would be unacceptable to the user if the event loses prompt answer changes after finishing browsing.
This event needs the following required arguments:
and the following optional arguments:
-
PROMPTS_EVENT_CLEAR_EXISTING_AND_ADD_UNITS
static final int PROMPTS_EVENT_CLEAR_EXISTING_AND_ADD_UNITS
Specifies an event to clear existing prompt answer and add new answer units to aPromptObject
contained in aPromptsBean
. This event acts exactly as the eventPROMPTS_EVENT_ADD_UNITS
except that it does an extra thing - clearing existing answer.This event applies to all types of WebPrompt but each type of prompt has different answer unit. For example, the answer unit for a
WebConstantPrompt
would be a single string; for aWebExpressionPrompt
, its answer unit is a sub expression constituting of aWebOperatorNode
and one or more operands, each of which is aWebNode
in general. Therefore, for different type of WebPrompt, users need to pass in different arguments to constitute a valid prompt answer unit.The argument
PROMPTS_EVENT_ARGUMENT_UNITS_TO_ADD
holds different items for different type of WebPrompt. ForWebObjectsPrompt
, it holds a list ofobjects
; forWebElementsPrompt
, it holds a list ofelements
; forWebExpressionPrompt
, it holds a list of constant string values for constituting an answer unit, which is a sub expression.When adding new answer units, this event also allows the users to change the function of root
WebOperatorNode
to eitherDssXmlFunctionAnd
orDssXmlFunctionOr
.This event needs the following required arguments:
and the following optional arguments:- See Also:
PROMPTS_EVENT_ADD_UNITS
, Constant Field Values
-
PROMPTS_EVENT_NAVIGATE_PROMPTS_BEAN
static final int PROMPTS_EVENT_NAVIGATE_PROMPTS_BEAN
Specifies an event to navigate through allPromptObject
contained in aPromptsBean
.Navigation through a PromptsBean is done by setting the current prompt position to wherever you want to be. The value of the prompt position is appended to the argument name of
PROMPTS_EVENT_ARGUMENT_NAVIGATION
, separated by the underscore character.To make it useful in DHTML mode where Javascript could be used, this event also processes prompt answers while navigating. It is totally reasonable that a user first moves the prompt answer around by using Javascript, and then starts navigating; it would be unacceptable to the user if the event loses prompt answer changes after finishing highlighting.
This event needs the following required arguments:
and the following optional arguments:- See Also:
- Constant Field Values
-
PROMPTS_EVENT_INCREMENTAL_FETCH
static final int PROMPTS_EVENT_INCREMENTAL_FETCH
Specifies an event to incremental fetchobjects
,elements
, etc. for aPromptObject
contained in aPromptsBean
.This event is very tight to the following two events:
PROMPTS_EVENT_BROWSE_ELEMENTS
andPROMPTS_EVENT_SEARCH_BY_NAME
. By specifying arguments likeblockBegin
andblockCount
, a user can incrementally fetchWebDisplayUnit
, if the result of element browsing or searching is too large to fit into his GUI component.To make it useful in DHTML mode where Javascript could be used, this event also processes prompt answers while fetching incrementally. It is totally reasonable that a user first moves the prompt answer around by using Javascript, and then starts incremental fetching; it would be unacceptable to the user if the event loses prompt answer changes after finishing incremental fetching.
This event needs the following required arguments:
and the following optional arguments:
-
PROMPTS_EVENT_SHOW_ALL_PROMPTS_SUMMARY
static final int PROMPTS_EVENT_SHOW_ALL_PROMPTS_SUMMARY
Specifies an event to show summary of allPromptObject
contained in aPromptsBean
.This event is actually a dummy event since it does nothing in it except that it loops through all prompts to process their answers. In DHTML mode where Javascript could be used, it is totally reasonable that a user first moves the prompt answer around by using Javascript, and then wants to show prompt summaries; it would be unacceptable to the user if the event loses prompt answer changes in the prompt summary page.
This event needs the following optional arguments:
-
PROMPTS_EVENT_SHOW_ANY_PROMPTS_SUMMARY
static final int PROMPTS_EVENT_SHOW_ANY_PROMPTS_SUMMARY
Specifies an event to show summary of any number ofPromptObject
contained in aPromptsBean
.This event does exactly the same thing as another event
PROMPTS_EVENT_PROCESS_ALL_PROMPTS
, except that this event requires prompt positions and only processes those PromptObject whose positions are specified in theRequestKeys
.This event is actually a dummy event since it does nothing in it except that it loops through all specified prompts to process their answers. In DHTML mode where Javascript could be used, it is totally reasonable that a user first moves the prompt answer around by using Javascript, and then wants to show prompt summaries; it would be unacceptable to the user if the event loses prompt answer changes in the prompt summary page.
This event needs the following required arguments:
and the following optional arguments:
-
PROMPTS_EVENT_BROWSE_HIERARCHICAL_PARENT_FOLDER
static final int PROMPTS_EVENT_BROWSE_HIERARCHICAL_PARENT_FOLDER
Specifies an event to browse the content of a parentWebFolder
of the current folder for aPromptObject
contained in aPromptsBean
.Very similar to the event
PROMPTS_EVENT_BROWSE_HIERARCHICAL_CHILD_FOLDER
, this event applies only toWebObjectsPrompt
,WebDimtyPrompt
orWebExpressionPrompt
when their origins are aWebSearch
object. In fact, the content of the folder to browse is brought back by searching in the project, and this event just changes the searching root on the origin, a WebSearch object.To make it useful in DHTML mode where Javascript could be used, this event also processes prompt answers while browsing folder contents. It is totally reasonable that a user first moves the prompt answer around by using Javascript, and then starts browsing; it would be unacceptable to the user if the event loses prompt answer changes after finishing browsing.
This event needs the following required arguments:
and the following optional arguments:
-
PROMPTS_EVENT_HIGHLIGHT_DIMENSION
static final int PROMPTS_EVENT_HIGHLIGHT_DIMENSION
Specifies an event to highlight aWebDimension
for aPromptObject
contained in aPromptsBean
.This event applies only to
WebExpressionPrompt
with its expression type equal toDssXmlFilterAllAttributeQual
. To make it useful in DHTML mode where Javascript could be used, this event also processes prompt answers while highlighting. It is totally reasonable that a user first moves the prompt answer around by using Javascript, and then starts highlighting; it would be unacceptable to the user if the event loses prompt answer changes after finishing highlighting.This event needs the following required arguments:
and the following optional arguments:- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ANSWER_PROMPTS_IN_ADVANCE
static final int PROMPTS_EVENT_ANSWER_PROMPTS_IN_ADVANCE
- Since:
- MicroStrategy Web 7.5.1
- See Also:
- Constant Field Values
-
PROMPTS_EVENT_CLEAR_HIERARCHICAL_SEARCH_EXPRESSION
static final int PROMPTS_EVENT_CLEAR_HIERARCHICAL_SEARCH_EXPRESSION
Specifies an event to clear the user search expression for aPromptObject
contained in aPromptsBean
.This event applies only to
WebExpressionPrompt
with its expression type equal toDssXmlFilterAllAttributeQual
.This event needs the following required arguments:
- Since:
- MicroStrategy Web 8.0.2
- See Also:
- Constant Field Values
-
PROMPTS_EVENT_BROWSE_DIMENSION_ATTRIBUTE_ELEMENTS
static final int PROMPTS_EVENT_BROWSE_DIMENSION_ATTRIBUTE_ELEMENTS
Specifies an event to browse elements of a dimension attribute for aPromptObject
contained in aPromptsBean
.This event applies only to
WebExpressionPrompt
with its expression type equal toDssXmlFilterAllAttributeQual
. It is similar to thePROMPTS_EVENT_BROWSE_ELEMENTS
except that there is no filter associated with the browsing. It is used for browsing a top level attribute in a dimension.This event needs the following required arguments:
and the following optional arguments:- Since:
- MicroStrategy Web 8.0.2
- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION
static final int PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION
Specifies an argument for prompt position, a non negative integer.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID
static final int PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID
Specifies an argument for aWebAttribute
or aWebDimensionAttribute
.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_FILTER_STRING
static final int PROMPTS_EVENT_ARGUMENT_FILTER_STRING
Specifies an argument for a filter string used in element browsing.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_BLOCK_BEGIN
static final int PROMPTS_EVENT_ARGUMENT_BLOCK_BEGIN
Specifies an argument for block begin for incremental fetch.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_BLOCK_COUNT
static final int PROMPTS_EVENT_ARGUMENT_BLOCK_COUNT
Specifies an argument for block count for incremental fetch.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_SEARCH_NAME
static final int PROMPTS_EVENT_ARGUMENT_SEARCH_NAME
Specifies an argument for the searching name.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_SEARCH_ROOT
static final int PROMPTS_EVENT_ARGUMENT_SEARCH_ROOT
Specifies an argument for the searchingroot
.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_ACTION_ADD_UNITS
static final int PROMPTS_EVENT_ARGUMENT_ACTION_ADD_UNITS
Specifies a user action to add more prompt answer units.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_ACTION_REMOVE_UNITS
static final int PROMPTS_EVENT_ARGUMENT_ACTION_REMOVE_UNITS
Specifies a user action to remove prompt answer units.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_ACTION_CANCEL_PROMPT
static final int PROMPTS_EVENT_ARGUMENT_ACTION_CANCEL_PROMPT
Specifies a user action to cancel answering a prompt.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_ACTION_ANSWER_PROMPT
static final int PROMPTS_EVENT_ARGUMENT_ACTION_ANSWER_PROMPT
Specifies a user action to answer a prompt.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_ACTION_SEARCH_BY_NAME
static final int PROMPTS_EVENT_ARGUMENT_ACTION_SEARCH_BY_NAME
Specifies a user action to searchobjects
by their names.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_ELEMENT
static final int PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_ELEMENT
- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_ANSWER
static final int PROMPTS_EVENT_ARGUMENT_ANSWER
Specifies an argument for the prompt answer units.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_UNITS_TO_ADD
static final int PROMPTS_EVENT_ARGUMENT_UNITS_TO_ADD
Specifies an argument for the prompt answer units to add. Depending on the prompt type, its value varies.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_UNITS_TO_REMOVE
static final int PROMPTS_EVENT_ARGUMENT_UNITS_TO_REMOVE
Specifies an argument for the prompt answer units to remove.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_SUB_ROOT_OPERATOR
static final int PROMPTS_EVENT_ARGUMENT_SUB_ROOT_OPERATOR
- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
static final int PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
Specifies an argument for the prompt answer format as inEnumPromptAnswerFormat
. The default answer format isPromptAnswerFormatFlat
.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_DIMENSION_ID
static final int PROMPTS_EVENT_ARGUMENT_DIMENSION_ID
Specifies an argument for adimension
.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_ACTION_DRILL_WITHIN_HIERARCHY
static final int PROMPTS_EVENT_ARGUMENT_ACTION_DRILL_WITHIN_HIERARCHY
Specifies a user action to drill up and down within ahierarchy
in aWebExpressionPrompt
.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION_ATTRIBUTE
static final int PROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION_ATTRIBUTE
Specifies a user action to highlight aWebDimensionAttribute
in aWebExpressionPrompt
.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_FUNCTION
static final int PROMPTS_EVENT_ARGUMENT_FUNCTION
- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_METRIC_ID
static final int PROMPTS_EVENT_ARGUMENT_METRIC_ID
Specifies an argument for aWebMetric
.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_PARENT_FOLDER_ID
static final int PROMPTS_EVENT_ARGUMENT_PARENT_FOLDER_ID
Specifies an argument for a parentWebFolder
.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_CHILD_FOLDER_ID
static final int PROMPTS_EVENT_ARGUMENT_CHILD_FOLDER_ID
Specifies an argument for a childWebFolder
.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_CHILD_FOLDER
static final int PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_CHILD_FOLDER
Specifies a user action to browse a childWebFolder
.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_DRILL_TO_ATTRIBUTE_ID
static final int PROMPTS_EVENT_ARGUMENT_DRILL_TO_ATTRIBUTE_ID
Specifies an argument for the drilled-toWebAttribute
.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_ACTION_CLEAR_EXISTING_AND_ADD_UNITS
static final int PROMPTS_EVENT_ARGUMENT_ACTION_CLEAR_EXISTING_AND_ADD_UNITS
Specifies a user action to clear the exsiting prompt answers and then add new ones.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID_AND_FORM_ID
static final int PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID_AND_FORM_ID
Specifies an argument for aWebAttribute
along with one of itsWebAttributeForm
, separated byUNIT_SEPARATOR
.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_NAVIGATION
static final int PROMPTS_EVENT_ARGUMENT_NAVIGATION
Specifies an argument for navigating through aPromptsBean
.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_ACTION_INCREMENTAL_FETCH
static final int PROMPTS_EVENT_ARGUMENT_ACTION_INCREMENTAL_FETCH
Specifies a user action to incrementally fetchWebDisplayUnit
.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_HIDDEN_DIMENSION_ID
static final int PROMPTS_EVENT_ARGUMENT_HIDDEN_DIMENSION_ID
Specifies an argument for a hidden variable in HTML to save the highlightedWebDimension
.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_HIDDEN_ATTRIBUTE_ID
static final int PROMPTS_EVENT_ARGUMENT_HIDDEN_ATTRIBUTE_ID
Specifies an argument for a hidden variable in HTML to save the highlightedWebAttribute
orWebDimensionAttribute
.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_MATCH_CASE
static final int PROMPTS_EVENT_ARGUMENT_MATCH_CASE
Specifies an argument for case-sensitive when buildingWebFilter
.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_ACTION_SHOW_SUMMARY
static final int PROMPTS_EVENT_ARGUMENT_ACTION_SHOW_SUMMARY
Specifies a user action to show the prompt summary.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_CALENDAR_BUTTON
static final int PROMPTS_EVENT_ARGUMENT_CALENDAR_BUTTON
Specifies an argument to show the calendar button.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS
static final int PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS
Specifies an argument for answeroptions
when dealing with null or empty answer in theRequestKeys
.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_PARENT_FOLDER
static final int PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_PARENT_FOLDER
Specifies a user action to browse a parentWebFolder
.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION
static final int PROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION
Specifies a user action to highlight aWebDimension
.- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_BROWSE_PATH
static final int PROMPTS_EVENT_ARGUMENT_BROWSE_PATH
Specifies an argument for the browse path in element browsing. An element browsing filter is built based on this path if it is passed in.- Since:
- MicroStrategy Web 7.5.0
- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID
static final int PROMPTS_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID
Specifies an argument for the original RW document message ID.- Since:
- MicroStrategy Web 7.5.1
- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML
static final int PROMPTS_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML
Specifies an argument for the prompt answers used in the original RW instance.- Since:
- MicroStrategy Web 7.5.1
- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER
static final int PROMPTS_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER
Specifies an argument for the prompt answers to theWebElementsPrompt
contained in the destination instance.- Since:
- MicroStrategy Web 7.5.1
- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_USER_SEPARATOR
static final int PROMPTS_EVENT_ARGUMENT_USER_SEPARATOR
Specifies an argument for user specified string separator.- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_REOPEN_PROMPT
static final int PROMPTS_EVENT_ARGUMENT_REOPEN_PROMPT
Speicifies an argument to re-open a closed prompt in Web. One typical usage senario is that a user wants to re-answer a prompt by clicking the browser back button. The default value is1
ortrue
, meaning to re-open the prompt in Web.Note, the prompt is re-opened in Web only. The Intelligence Server still keeps the prompt closed, but the new answers are accepted by the Intelligence Server.
- Since:
- MicroStrategy Web 8.0.0
- See Also:
EnumReportBeanEvents.REPORT_EVENT_REFRESH
, Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_SUBMIT_ANSWER
static final int PROMPTS_EVENT_ARGUMENT_SUBMIT_ANSWER
Specifies an argument to submit the prompt answer. The default value is1
ortrue
meaning to submit the prompt answer.- Since:
- MicroStrategy Web 8.0.0
- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_SAP_VARIABLE_EXCLUDE
static final int PROMPTS_EVENT_ARGUMENT_SAP_VARIABLE_EXCLUDE
Specifies an argument to indicate anEXCLUDE
sub-expression in the prompt answer for supporting SAP Variables. Its default value should befalse
,include
, or0
which meansINCLUDE
.- Since:
- MicroStrategy Web 8.0.1
- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_DO_NOT_AUTO_REPROMPT
static final int PROMPTS_EVENT_ARGUMENT_DO_NOT_AUTO_REPROMPT
Specifies an argument not to automatically re-open prompts in the Intelligence Server when all prompts are closed. By default its value isfalse
. A value ofTrue
or1
means the booleantrue
.- Since:
- MicroStrategy Web 8.0.2
- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_OBJECT_TYPE
static final int PROMPTS_EVENT_ARGUMENT_OBJECT_TYPE
Specifies an argument describing an object type that is relevant to an event. This value should either be omitted or be from EnumDSSXMLObjectTypes.- Since:
- MicroStrategy Web 8.0.2
- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER
static final int PROMPTS_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER
- Since:
- MicroStrategy Web 8.1.0
- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_PLAIN_OBJECT_PROMPT_ANSWER
static final int PROMPTS_EVENT_ARGUMENT_PLAIN_OBJECT_PROMPT_ANSWER
- Since:
- MicroStrategy Web 8.1.0
- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_LINK_ANSWERS
static final int PROMPTS_EVENT_ARGUMENT_LINK_ANSWERS
- Since:
- MicroStrategy Web 8.1.2
- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_INCREMENTAL_FETCH_GOTO_PAGE
static final int PROMPTS_EVENT_ARGUMENT_INCREMENTAL_FETCH_GOTO_PAGE
Specifies an argument to go to a particular page for incrementally fetching objects and elements.- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_MESSAGE_ALIAS
static final int PROMPTS_EVENT_ARGUMENT_MESSAGE_ALIAS
Option to rename the message of the resulting report or document.- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_USE_SET_ANSWERS
static final int PROMPTS_EVENT_ARGUMENT_USE_SET_ANSWERS
The argument for the Answer all prompts to indicate that we should use the already set answers saved on the prompt beans effectively ignoring the other argumentsPROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS
,PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT
.- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_ANSWER_MODE_OPTION
static final int PROMPTS_EVENT_ARGUMENT_ANSWER_MODE_OPTION
An integer prompt answer mode fromEnumWebPromptAnswerMode
- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_SRC_ANSWERS
static final int PROMPTS_EVENT_ARGUMENT_SRC_ANSWERS
- See Also:
- Constant Field Values
-
PROMPTS_EVENT_ARGUMENT_EXEC_FLAGS
static final int PROMPTS_EVENT_ARGUMENT_EXEC_FLAGS
- See Also:
- Constant Field Values
-
SIMPLE_SEPARATOR_SEMICOLON
static final java.lang.String SIMPLE_SEPARATOR_SEMICOLON
Specifies a simple separator to delimit two string constant values. The string constant should not contain the semicolon character ';'.- See Also:
SIMPLE_SEPARATOR_COMMA
, Constant Field Values
-
UNIT_SEPARATOR
static final java.lang.String UNIT_SEPARATOR
Specifies a separator to delimit twoWebDisplayUnit
, each of which is represented as a string concatenation of ID, type, and displayName.- See Also:
ITEM_SEPARATOR
, Constant Field Values
-
ITEM_SEPARATOR
static final java.lang.String ITEM_SEPARATOR
Specifies a separator to delimit each item contained in the string representation of aWebDisplayUnit
. AWebDisplayUnit
typically has ID, type and displayName and its string representation is just the string concatenation of the three items above in the listed order.- See Also:
- Constant Field Values
-
EXPRESSION_SEPARATOR
static final java.lang.String EXPRESSION_SEPARATOR
Specifies a separator to delimit expression elements within a expression answer unit forWebExpressionPrompt
in theflat
format.A typical expression answer unit contains a
WebOperatorNode
, aWebShortcutNode
or aWebFormShortcutNode
, and a list ofWebConstantNode
. This separator is used to delimit the above three expression elements.- See Also:
UNIT_SEPARATOR
,ITEM_SEPARATOR
, Constant Field Values
-
ANSWER_SEPARATOR
static final java.lang.String ANSWER_SEPARATOR
Specifies a separator to delimit two answer units in theflat
format.- See Also:
EXPRESSION_SEPARATOR
,UNIT_SEPARATOR
, Constant Field Values
-
ITEM_SPECIAL_SEPARATOR
static final java.lang.String ITEM_SPECIAL_SEPARATOR
Specifies a separator to delimit each item contained in the string representation of aWebDisplayUnit
. AWebDisplayUnit
typically has ID, type and displayName and its string representation is just the string concatenation of the three items above in the listed order.This separator is used when
WebDisplayUnit
ID contains "~1048576~"- See Also:
ITEM_SEPARATOR
, Constant Field Values
-
SIMPLE_SEPARATOR_COMMA
static final java.lang.String SIMPLE_SEPARATOR_COMMA
Specifies a simple separator to delimit two string constant values. The string constant should not contain the comma character ','.This separator can be used as the substitution of the
SIMPLE_SEPARATOR_SEMICOLON
only when the prompt is aWebExpressionPrompt
with its expression type ofDssXmlFilterAttributeDESCQual
orDssXmlFilterAttributeIDQual
when the operator isDssXmlFunctionIn
.- See Also:
SIMPLE_SEPARATOR_SEMICOLON
, Constant Field Values
-
SIMPLE_SEPARATOR_CARET
static final java.lang.String SIMPLE_SEPARATOR_CARET
Specifies a simple separator to delimit an element ID and its element display name in the URL prompt answer forWebElementsPrompt
.The element displayName should be URL encoded with UTF-8 format to avoid any URL unfriendly characters.
- Since:
- MicroStrategy Web 7.5.4
- See Also:
- Constant Field Values
-
-