Supported Bean: PromptsBean

This interface acts as a controller to orchestrate the collection and assembly of prompt questions. There are two different modes of operation: An instance of the PromptsBean can be retrieved from the ReportBean, DocumentBean, RWBean, SubscriptionBean, ScheduleBean

Event handler: com.microstrategy.web.beans.EnumEventHandlerTypes.HANDLER_TYPE_PROMPTS (8)

Event handler that can be associated with a Prompts Bean.

Events

AddUnits, AnswerAllPrompts, AnswerAnyPrompts, AnswerConstantPrompt, AnswerDimtyPrompt, AnswerElementsPrompt, AnswerExpressionPrompt, AnswerObjectsPrompt, AnswerPromptsInAdvance, BrowseDimensionAttributeElements, BrowseElements, BrowseHierarchicalChildFolder, BrowseHierarchicalParentFolder, CancelAllPrompts, CancelAnyPrompts, ClearAndAddUnits, ClearHierarchicalSearchExpression, DrillWithinHierarchy, HighlightDimension, HighlightDimensionAttribute, IncrementalFetch, NavigatePromptsBean, ProcessAllPrompts, ProcessAnyPrompts, RemoveUnits, SearchByName, ShowAllPromptsSummary, ShowAnyPromptsSummary

AddUnits
Specifies an event to add new answer units to the existing answer of a PromptObject contained in a PromptsBean.

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 a WebExpressionPrompt, its answer unit is a sub expression constituting of a WebOperatorNode and one or more operands, each of which is a WebNode in general. Therefore, for different type of WebPrompt, users need to pass in different arguments to constitute a valid prompt answer unit.

The argument EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_UNITS_TO_ADD holds different items for different type of WebPrompt. For WebObjectsPrompt, it holds a list of objects; for WebElementsPrompt, it holds a list of elements; for WebExpressionPrompt, 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 either DssXmlFunctionAnd or DssXmlFunctionOr.

This event needs the following required arguments:

and the following optional arguments:

8009

EnumPromptsBeanEvents.PROMPTS_EVENT_ADD_UNITS

*position

Specifies an argument for prompt position, a non negative integer.

8201

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

*unitsToAdd

Specifies an argument for the prompt answer units to add. Depending on the prompt type, its value varies.

8215

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_UNITS_TO_ADD

attributeIDWithFormID

Specifies an argument for a WebAttribute along with one of its WebAttributeForm, separated by EnumPromptsBeanEvents.UNIT_SEPARATOR.

8229

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID_AND_FORM_ID

funcVal

Specifies an argument for the funtion of an WebOperatorNode in a WebExpression.

8222

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_FUNCTION

hiddenAttributeID

Specifies an argument for a hidden variable in HTML to save the highlighted WebAttribute or WebDimensionAttribute.

8233

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_HIDDEN_ATTRIBUTE_ID

hiddenDimensionID

Specifies an argument for a hidden variable in HTML to save the highlighted WebDimension.

8232

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_HIDDEN_DIMENSION_ID

metricID

Specifies an argument for a WebMetric.

8223

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_METRIC_ID

rootOperator

Specifies an argument for the function of the root node of an expression.

8217

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_SUB_ROOT_OPERATOR

SAPVariableExclude

Specifies an argument to indicate an EXCLUDE sub-expression in the prompt answer for supporting SAP Variables. Its default value should be false, include, or 0 which means INCLUDE.

8247

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_SAP_VARIABLE_EXCLUDE
AnswerAllPrompts
Specifies an event to answer all the PromptObject contained in a PromptsBean.

This event needs the following optional arguments:

8001

EnumPromptsBeanEvents.PROMPTS_EVENT_ANSWER_ALL_PROMPTS

alias

Option to rename the message of the resulting report or document.

8254

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_MESSAGE_ALIAS

answer

Specifies an argument for the prompt answer units.

8214

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER

answerFormat

Specifies an argument for the prompt answer format as in EnumPromptAnswerFormat. The default answer format is PromptAnswerFormatFlat.

8218

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT

answerOptions

Specifies an argument for answer options when dealing with null or empty answer in the RequestKeys.

8237

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

doNotAutoReprompt

Specifies an argument not to automatically re-open prompts in the Intelligence Server when all prompts are closed. By default its value is false. A value of True or 1 means the boolean true.

8248

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_DO_NOT_AUTO_REPROMPT

execFlags

8258

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_EXEC_FLAGS

reOpenPrompt

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 is 1 or true, 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.

8245

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_REOPEN_PROMPT

submitAnswer

Specifies an argument to submit the prompt answer. The default value is 1 or true meaning to submit the prompt answer.

8246

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_SUBMIT_ANSWER

userStringSeparator

Specifies an argument for user specified string separator.

8244

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_USER_SEPARATOR

useSetAnswers

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 arguments EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS, EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT.

8255

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_USE_SET_ANSWERS
AnswerAnyPrompts
Specifies an event to answer any number of PromptObject contained in a PromptsBean, 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:

8002

EnumPromptsBeanEvents.PROMPTS_EVENT_ANSWER_ANY_PROMPTS

*position

Specifies an argument for prompt position, a non negative integer.

8201

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

alias

Option to rename the message of the resulting report or document.

8254

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_MESSAGE_ALIAS

answer

Specifies an argument for the prompt answer units.

8214

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER

answerFormat

Specifies an argument for the prompt answer format as in EnumPromptAnswerFormat. The default answer format is PromptAnswerFormatFlat.

8218

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT

answerOptions

Specifies an argument for answer options when dealing with null or empty answer in the RequestKeys.

8237

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

userStringSeparator

Specifies an argument for user specified string separator.

8244

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_USER_SEPARATOR
AnswerConstantPrompt
Specifies an event to answer a WebConstantPrompt at the specified prompt position in a PromptsBean.

This event needs the following required arguments:

and the following optional arguments:

8003

EnumPromptsBeanEvents.PROMPTS_EVENT_ANSWER_CONSTANT_PROMPT

*position

Specifies an argument for prompt position, a non negative integer.

8201

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

answer

Specifies an argument for the prompt answer units.

8214

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER

answerFormat

Specifies an argument for the prompt answer format as in EnumPromptAnswerFormat. The default answer format is PromptAnswerFormatFlat.

8218

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT

answerOptions

Specifies an argument for answer options when dealing with null or empty answer in the RequestKeys.

8237

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS
AnswerDimtyPrompt
Specifies an event to answer a WebDimtyPrompt at the specified prompt position in a PromptsBean.

This event needs the following required arguments:

and the following optional arguments:

8005

EnumPromptsBeanEvents.PROMPTS_EVENT_ANSWER_DIMTY_PROMPT

*position

Specifies an argument for prompt position, a non negative integer.

8201

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

answer

Specifies an argument for the prompt answer units.

8214

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER

answerFormat

Specifies an argument for the prompt answer format as in EnumPromptAnswerFormat. The default answer format is PromptAnswerFormatFlat.

8218

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT

answerOptions

Specifies an argument for answer options when dealing with null or empty answer in the RequestKeys.

8237

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS
AnswerElementsPrompt
Specifies an event to answer a WebElementsPrompt at the specified prompt position in a PromptsBean.

This event needs the following required arguments:

and the following optional arguments:

8006

EnumPromptsBeanEvents.PROMPTS_EVENT_ANSWER_ELEMENTS_PROMPT

*position

Specifies an argument for prompt position, a non negative integer.

8201

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

answer

Specifies an argument for the prompt answer units.

8214

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER

answerFormat

Specifies an argument for the prompt answer format as in EnumPromptAnswerFormat. The default answer format is PromptAnswerFormatFlat.

8218

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT

answerOptions

Specifies an argument for answer options when dealing with null or empty answer in the RequestKeys.

8237

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS
AnswerExpressionPrompt
Specifies an event to answer a WebExpressionPrompt at the specified prompt position in a PromptsBean.

This event needs the following required arguments:

and the following optional arguments:

8007

EnumPromptsBeanEvents.PROMPTS_EVENT_ANSWER_EXPRESSION_PROMPT

*position

Specifies an argument for prompt position, a non negative integer.

8201

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

answer

Specifies an argument for the prompt answer units.

8214

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER

answerFormat

Specifies an argument for the prompt answer format as in EnumPromptAnswerFormat. The default answer format is PromptAnswerFormatFlat.

8218

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT

answerOptions

Specifies an argument for answer options when dealing with null or empty answer in the RequestKeys.

8237

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

rootOperator

Specifies an argument for the function of the root node of an expression.

8217

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_SUB_ROOT_OPERATOR

userStringSeparator

Specifies an argument for user specified string separator.

8244

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_USER_SEPARATOR
AnswerObjectsPrompt
Specifies an event to answer a WebObjectsPrompt at the specified prompt position in a PromptsBean.

This event needs the following required arguments:

and the following optional arguments:

8004

EnumPromptsBeanEvents.PROMPTS_EVENT_ANSWER_OBJECTS_PROMPT

*position

Specifies an argument for prompt position, a non negative integer.

8201

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

answer

Specifies an argument for the prompt answer units.

8214

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER

answerFormat

Specifies an argument for the prompt answer format as in EnumPromptAnswerFormat. The default answer format is PromptAnswerFormatFlat.

8218

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT

answerOptions

Specifies an argument for answer options when dealing with null or empty answer in the RequestKeys.

8237

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS
AnswerPromptsInAdvance

8026

EnumPromptsBeanEvents.PROMPTS_EVENT_ANSWER_PROMPTS_IN_ADVANCE

doNotAutoReprompt

Specifies an argument not to automatically re-open prompts in the Intelligence Server when all prompts are closed. By default its value is false. A value of True or 1 means the boolean true.

8248

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_DO_NOT_AUTO_REPROMPT

elementsPromptAnswers

Specifies an argument for the prompt answers to the WebElementsPrompt contained in the destination instance.

8243

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

linkAnswers

8252

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_LINK_ANSWERS

objectsPromptAnswers

8251

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PLAIN_OBJECT_PROMPT_ANSWER

objectType

Specifies an argument describing an object type that is relevant to an event. This value should either be omitted or be from EnumDSSXMLObjectTypes.

8249

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_OBJECT_TYPE

originMessageID

Specifies an argument for the original RW document message ID.

8241

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

promptAnswerMode

An integer prompt answer mode from EnumWebPromptAnswerMode

8256

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_MODE_OPTION

promptsAnswerXML

Specifies an argument for the prompt answers used in the original RW instance.

8242

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

srcAnswers

8257

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_SRC_ANSWERS

valuePromptAnswers

8250

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER
BrowseDimensionAttributeElements
Specifies an event to browse elements of a dimension attribute for a PromptObject contained in a PromptsBean.

This event applies only to WebExpressionPrompt with its expression type equal to DssXmlFilterAllAttributeQual. It is similar to the EnumPromptsBeanEvents.PROMPTS_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:

8028

EnumPromptsBeanEvents.PROMPTS_EVENT_BROWSE_DIMENSION_ATTRIBUTE_ELEMENTS

*hiddenAttributeID

Specifies an argument for a hidden variable in HTML to save the highlighted WebAttribute or WebDimensionAttribute.

8233

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_HIDDEN_ATTRIBUTE_ID

*hiddenDimensionID

Specifies an argument for a hidden variable in HTML to save the highlighted WebDimension.

8232

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_HIDDEN_DIMENSION_ID

*position

Specifies an argument for prompt position, a non negative integer.

8201

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

answer

Specifies an argument for the prompt answer units.

8214

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER

answerFormat

Specifies an argument for the prompt answer format as in EnumPromptAnswerFormat. The default answer format is PromptAnswerFormatFlat.

8218

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT

answerOptions

Specifies an argument for answer options when dealing with null or empty answer in the RequestKeys.

8237

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

blockBegin

Specifies an argument for block begin for incremental fetch.

8204

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_BLOCK_BEGIN

blockCount

Specifies an argument for block count for incremental fetch.

8205

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_BLOCK_COUNT
BrowseElements
Specifies an event to browse WebElement of a WebAttribute for a PromptObject contained in a PromptsBean.

This event applies only to WebElementsPrompt or WebExpressionPrompt with its expression type equal to DssXmlFilterAllAttributeQual. For WebElementsPrompt, since its origin is a single WebAttribute, no attribute needs to be specified in the RequestKeys; but for WebExpressionPrompt, it requires to pass in both the WebDimension object and its belonging WebDimensionAttribute 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): 

      FilterString    =   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
Any non-null value for the EnumPromptsBeanEvents.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:

8013

EnumPromptsBeanEvents.PROMPTS_EVENT_BROWSE_ELEMENTS

*position

Specifies an argument for prompt position, a non negative integer.

8201

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

answer

Specifies an argument for the prompt answer units.

8214

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER

answerFormat

Specifies an argument for the prompt answer format as in EnumPromptAnswerFormat. The default answer format is PromptAnswerFormatFlat.

8218

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT

answerOptions

Specifies an argument for answer options when dealing with null or empty answer in the RequestKeys.

8237

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

blockBegin

Specifies an argument for block begin for incremental fetch.

8204

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_BLOCK_BEGIN

blockCount

Specifies an argument for block count for incremental fetch.

8205

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_BLOCK_COUNT

browsePath

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.

8240

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_BROWSE_PATH

filterString

Specifies an argument for a filter string used in element browsing.

8203

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_FILTER_STRING

hiddenAttributeID

Specifies an argument for a hidden variable in HTML to save the highlighted WebAttribute or WebDimensionAttribute.

8233

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_HIDDEN_ATTRIBUTE_ID

hiddenDimensionID

Specifies an argument for a hidden variable in HTML to save the highlighted WebDimension.

8232

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_HIDDEN_DIMENSION_ID

matchCase

Specifies an argument for case-sensitive when building WebFilter.

8234

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_MATCH_CASE
BrowseHierarchicalChildFolder
Specifies an event to browse the content of a child WebFolder of the current folder for a PromptObject contained in a PromptsBean.

This event applies only to WebObjectsPrompt, WebDimtyPrompt or WebExpressionPrompt when their origins are a WebSearch 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:

8018

EnumPromptsBeanEvents.PROMPTS_EVENT_BROWSE_HIERARCHICAL_CHILD_FOLDER

*childFolderID

Specifies an argument for a child WebFolder.

8225

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_CHILD_FOLDER_ID

*position

Specifies an argument for prompt position, a non negative integer.

8201

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

answer

Specifies an argument for the prompt answer units.

8214

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER

answerFormat

Specifies an argument for the prompt answer format as in EnumPromptAnswerFormat. The default answer format is PromptAnswerFormatFlat.

8218

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT

answerOptions

Specifies an argument for answer options when dealing with null or empty answer in the RequestKeys.

8237

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS
BrowseHierarchicalParentFolder
Specifies an event to browse the content of a parent WebFolder of the current folder for a PromptObject contained in a PromptsBean.

Very similar to the event EnumPromptsBeanEvents.PROMPTS_EVENT_BROWSE_HIERARCHICAL_CHILD_FOLDER, this event applies only to WebObjectsPrompt, WebDimtyPrompt or WebExpressionPrompt when their origins are a WebSearch 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:

8024

EnumPromptsBeanEvents.PROMPTS_EVENT_BROWSE_HIERARCHICAL_PARENT_FOLDER

*position

Specifies an argument for prompt position, a non negative integer.

8201

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

*promptParentFolderID

Specifies an argument for a parent WebFolder.

8224

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PARENT_FOLDER_ID

answer

Specifies an argument for the prompt answer units.

8214

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER

answerFormat

Specifies an argument for the prompt answer format as in EnumPromptAnswerFormat. The default answer format is PromptAnswerFormatFlat.

8218

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT

answerOptions

Specifies an argument for answer options when dealing with null or empty answer in the RequestKeys.

8237

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS
CancelAllPrompts
Specifies an event to cancel answering all PromptObject contained in a PromptsBean.

Validation error is thrown if it is a required prompt.

This event needs no required or optional arguments.

8012

EnumPromptsBeanEvents.PROMPTS_EVENT_CANCEL_ALL_PROMPTS
CancelAnyPrompts
Specifies an event to cancel answering any number of PromptObject contained in a PromptsBean.

Validation error is thrown if it is a required prompt.

This event needs the following required arguments:

8011

EnumPromptsBeanEvents.PROMPTS_EVENT_CANCEL_ANY_PROMPTS

*position

Specifies an argument for prompt position, a non negative integer.

8201

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION
ClearAndAddUnits
Specifies an event to clear existing prompt answer and add new answer units to a PromptObject contained in a PromptsBean. This event acts exactly as the event EnumPromptsBeanEvents.PROMPTS_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 a WebExpressionPrompt, its answer unit is a sub expression constituting of a WebOperatorNode and one or more operands, each of which is a WebNode in general. Therefore, for different type of WebPrompt, users need to pass in different arguments to constitute a valid prompt answer unit.

The argument EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_UNITS_TO_ADD holds different items for different type of WebPrompt. For WebObjectsPrompt, it holds a list of objects; for WebElementsPrompt, it holds a list of elements; for WebExpressionPrompt, 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 either DssXmlFunctionAnd or DssXmlFunctionOr.

This event needs the following required arguments:

and the following optional arguments:

8019

EnumPromptsBeanEvents.PROMPTS_EVENT_CLEAR_EXISTING_AND_ADD_UNITS

*position

Specifies an argument for prompt position, a non negative integer.

8201

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

*unitsToAdd

Specifies an argument for the prompt answer units to add. Depending on the prompt type, its value varies.

8215

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_UNITS_TO_ADD

attributeIDWithFormID

Specifies an argument for a WebAttribute along with one of its WebAttributeForm, separated by EnumPromptsBeanEvents.UNIT_SEPARATOR.

8229

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID_AND_FORM_ID

funcVal

Specifies an argument for the funtion of an WebOperatorNode in a WebExpression.

8222

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_FUNCTION

hiddenAttributeID

Specifies an argument for a hidden variable in HTML to save the highlighted WebAttribute or WebDimensionAttribute.

8233

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_HIDDEN_ATTRIBUTE_ID

hiddenDimensionID

Specifies an argument for a hidden variable in HTML to save the highlighted WebDimension.

8232

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_HIDDEN_DIMENSION_ID

metricID

Specifies an argument for a WebMetric.

8223

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_METRIC_ID

rootOperator

Specifies an argument for the function of the root node of an expression.

8217

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_SUB_ROOT_OPERATOR
ClearHierarchicalSearchExpression
Specifies an event to clear the user search expression for a PromptObject contained in a PromptsBean.

This event applies only to WebExpressionPrompt with its expression type equal to DssXmlFilterAllAttributeQual.

This event needs the following required arguments:

8027

EnumPromptsBeanEvents.PROMPTS_EVENT_CLEAR_HIERARCHICAL_SEARCH_EXPRESSION

*hiddenAttributeID

Specifies an argument for a hidden variable in HTML to save the highlighted WebAttribute or WebDimensionAttribute.

8233

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_HIDDEN_ATTRIBUTE_ID

*hiddenDimensionID

Specifies an argument for a hidden variable in HTML to save the highlighted WebDimension.

8232

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_HIDDEN_DIMENSION_ID

*position

Specifies an argument for prompt position, a non negative integer.

8201

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION
DrillWithinHierarchy
Specifies an event to drill to a WebDimensionAttribute up and down within a hierarchy for a PromptObject contained in a PromptsBean.

This event applies only to WebExpressionPrompt with its expression type equal to DssXmlFilterAllAttributeQual. 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 argument EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_UNITS_TO_ADD can be used for passing the list of WebElement.

This event needs the following required arguments:

and the following optional arguments:

8016

EnumPromptsBeanEvents.PROMPTS_EVENT_DRILL_WITHIN_HIERARCHY

*hiddenDimensionID

Specifies an argument for a hidden variable in HTML to save the highlighted WebDimension.

8232

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_HIDDEN_DIMENSION_ID

*hiddenFromAttributeID

Specifies an argument for a hidden variable in HTML to save the highlighted WebAttribute or WebDimensionAttribute.

8233

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_HIDDEN_ATTRIBUTE_ID

*position

Specifies an argument for prompt position, a non negative integer.

8201

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

*toAttributeID

Specifies an argument for the drilled-to WebAttribute.

8227

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_DRILL_TO_ATTRIBUTE_ID

answer

Specifies an argument for the prompt answer units.

8214

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER

answerFormat

Specifies an argument for the prompt answer format as in EnumPromptAnswerFormat. The default answer format is PromptAnswerFormatFlat.

8218

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT

answerOptions

Specifies an argument for answer options when dealing with null or empty answer in the RequestKeys.

8237

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

browsePath

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.

8240

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_BROWSE_PATH

parentFolder

Specifies an argument for the searching root.

8207

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_SEARCH_ROOT

unitsToAdd

Specifies an argument for the prompt answer units to add. Depending on the prompt type, its value varies.

8215

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_UNITS_TO_ADD
HighlightDimension
Specifies an event to highlight a WebDimension for a PromptObject contained in a PromptsBean.

This event applies only to WebExpressionPrompt with its expression type equal to DssXmlFilterAllAttributeQual. 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:

8025

EnumPromptsBeanEvents.PROMPTS_EVENT_HIGHLIGHT_DIMENSION

*dimensionID

Specifies an argument for a dimension.

8219

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_DIMENSION_ID

*position

Specifies an argument for prompt position, a non negative integer.

8201

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

answer

Specifies an argument for the prompt answer units.

8214

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER

answerFormat

Specifies an argument for the prompt answer format as in EnumPromptAnswerFormat. The default answer format is PromptAnswerFormatFlat.

8218

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT

answerOptions

Specifies an argument for answer options when dealing with null or empty answer in the RequestKeys.

8237

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

parentFolder

Specifies an argument for the searching root.

8207

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_SEARCH_ROOT
HighlightDimensionAttribute
Specifies an event to highlight a WebDimensionAttribute in a hierarchy for a PromptObject contained in a PromptsBean.

This event applies only to WebExpressionPrompt with its expression type equal to DssXmlFilterAllAttributeQual. 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:

8017

EnumPromptsBeanEvents.PROMPTS_EVENT_HIGHLIGHT_DIMENSION_ATTRIBUTE

*attributeID

Specifies an argument for a WebAttribute or a WebDimensionAttribute.

8202

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID

*hiddenDimensionID

Specifies an argument for a hidden variable in HTML to save the highlighted WebDimension.

8232

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_HIDDEN_DIMENSION_ID

*position

Specifies an argument for prompt position, a non negative integer.

8201

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

answer

Specifies an argument for the prompt answer units.

8214

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER

answerFormat

Specifies an argument for the prompt answer format as in EnumPromptAnswerFormat. The default answer format is PromptAnswerFormatFlat.

8218

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT

answerOptions

Specifies an argument for answer options when dealing with null or empty answer in the RequestKeys.

8237

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

parentFolder

Specifies an argument for the searching root.

8207

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_SEARCH_ROOT
IncrementalFetch
Specifies an event to incremental fetch objects, elements, etc. for a PromptObject contained in a PromptsBean.

This event is very tight to the following two events: EnumPromptsBeanEvents.PROMPTS_EVENT_BROWSE_ELEMENTS and EnumPromptsBeanEvents.PROMPTS_EVENT_SEARCH_BY_NAME. By specifying arguments like blockBegin and blockCount, a user can incrementally fetch WebDisplayUnit, 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:

8021

EnumPromptsBeanEvents.PROMPTS_EVENT_INCREMENTAL_FETCH

*position

Specifies an argument for prompt position, a non negative integer.

8201

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

answer

Specifies an argument for the prompt answer units.

8214

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER

answerFormat

Specifies an argument for the prompt answer format as in EnumPromptAnswerFormat. The default answer format is PromptAnswerFormatFlat.

8218

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT

answerOptions

Specifies an argument for answer options when dealing with null or empty answer in the RequestKeys.

8237

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

blockBegin

Specifies an argument for block begin for incremental fetch.

8204

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_BLOCK_BEGIN

blockCount

Specifies an argument for block count for incremental fetch.

8205

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_BLOCK_COUNT

gotoPageId

Specifies an argument to go to a particular page for incrementally fetching objects and elements.

8253

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_INCREMENTAL_FETCH_GOTO_PAGE
NavigatePromptsBean
Specifies an event to navigate through all PromptObject contained in a PromptsBean.

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 EnumPromptsBeanEvents.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:

8020

EnumPromptsBeanEvents.PROMPTS_EVENT_NAVIGATE_PROMPTS_BEAN

*navigation

Specifies an argument for navigating through a PromptsBean.

8230

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_NAVIGATION

answer

Specifies an argument for the prompt answer units.

8214

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER

answerFormat

Specifies an argument for the prompt answer format as in EnumPromptAnswerFormat. The default answer format is PromptAnswerFormatFlat.

8218

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT

answerOptions

Specifies an argument for answer options when dealing with null or empty answer in the RequestKeys.

8237

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS
ProcessAllPrompts
Specifies an event to process any supported user action for all PromptObject contained in a PromptsBean.

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 EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_INCREMENTAL_FETCH, look for those arguments defined in the corresponding smaller event EnumPromptsBeanEvents.PROMPTS_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 EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_DIMENSION_ID is a required argument for the user action EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION.

This event needs the following optional arguments:

8008

EnumPromptsBeanEvents.PROMPTS_EVENT_PROCESS_ALL_PROMPTS

addUnitsButton

Specifies a user action to add more prompt answer units.

8208

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_ADD_UNITS

alias

Option to rename the message of the resulting report or document.

8254

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_MESSAGE_ALIAS

answer

Specifies an argument for the prompt answer units.

8214

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER

answerButton

Specifies a user action to answer a prompt.

8211

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_ANSWER_PROMPT

answerFormat

Specifies an argument for the prompt answer format as in EnumPromptAnswerFormat. The default answer format is PromptAnswerFormatFlat.

8218

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT

answerOptions

Specifies an argument for answer options when dealing with null or empty answer in the RequestKeys.

8237

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

attributeId

Specifies an argument for a WebAttribute or a WebDimensionAttribute.

8202

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID

attributeIDWithFormID

Specifies an argument for a WebAttribute along with one of its WebAttributeForm, separated by EnumPromptsBeanEvents.UNIT_SEPARATOR.

8229

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID_AND_FORM_ID

blockBegin

Specifies an argument for block begin for incremental fetch.

8204

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_BLOCK_BEGIN

blockCount

Specifies an argument for block count for incremental fetch.

8205

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_BLOCK_COUNT

browseChildFolderButton

Specifies a user action to browse a child WebFolder.

8226

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_CHILD_FOLDER

browseElementButton

Specifies a user action to browse elements under an attribute.

8213

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_ELEMENT

browseParentFolderButton

Specifies a user action to browse a parent WebFolder.

8238

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_PARENT_FOLDER

browsePath

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.

8240

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_BROWSE_PATH

calendarButton

Specifies an argument to show the calendar button.

8236

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_CALENDAR_BUTTON

cancelButton

Specifies a user action to cancel answering a prompt.

8210

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_CANCEL_PROMPT

childFolderID

Specifies an argument for a child WebFolder.

8225

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_CHILD_FOLDER_ID

clearAndAddUnitsButton

Specifies a user action to clear the exsiting prompt answers and then add new ones.

8228

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_CLEAR_EXISTING_AND_ADD_UNITS

dimensionID

Specifies an argument for a dimension.

8219

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_DIMENSION_ID

doNotAutoReprompt

Specifies an argument not to automatically re-open prompts in the Intelligence Server when all prompts are closed. By default its value is false. A value of True or 1 means the boolean true.

8248

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_DO_NOT_AUTO_REPROMPT

drillWithinHierarchyButton

Specifies a user action to drill up and down within a hierarchy in a WebExpressionPrompt.

8220

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_DRILL_WITHIN_HIERARCHY

filterXml

Specifies an argument for a filter string used in element browsing.

8203

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_FILTER_STRING

funcVal

Specifies an argument for the funtion of an WebOperatorNode in a WebExpression.

8222

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_FUNCTION

gotoPageId

Specifies an argument to go to a particular page for incrementally fetching objects and elements.

8253

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_INCREMENTAL_FETCH_GOTO_PAGE

hiddenAttributeID

Specifies an argument for a hidden variable in HTML to save the highlighted WebAttribute or WebDimensionAttribute.

8233

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_HIDDEN_ATTRIBUTE_ID

hiddenDimensionID

Specifies an argument for a hidden variable in HTML to save the highlighted WebDimension.

8232

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_HIDDEN_DIMENSION_ID

highlightDimensionAttributeButton

Specifies a user action to highlight a WebDimensionAttribute in a WebExpressionPrompt.

8221

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION_ATTRIBUTE

highlightDimensionButton

Specifies a user action to highlight a WebDimension.

8239

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION

incrementalFetchButton

Specifies a user action to incrementally fetch WebDisplayUnit.

8231

EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_INCREMENTAL_FETCH

loadFile

Argument to specify a name 'Load file' button.
String value for this button.
It is a parameter for following event:
  • EnumPromptsBeanEvents.PROMPTS_EVENT_ANSWER_ALL_PROMPTS

    • 5014

    EnumPageEvents.WebEventArgumentLoadFile

    matchCase

    		Specifies an argument for case-sensitive when building WebFilter.

    8234

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_MATCH_CASE

    metricID

    		Specifies an argument for a WebMetric.

    8223

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_METRIC_ID

    navigation

    		Specifies an argument for navigating through a PromptsBean.

    8230

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_NAVIGATION

    promptParentFolderID

    		Specifies an argument for a parent WebFolder.

    8224

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PARENT_FOLDER_ID

    removeUnitsButton

    		Specifies a user action to remove prompt answer units.

    8209

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_REMOVE_UNITS

    reOpenPrompt

    		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 is 1 or true, 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.

    8245

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_REOPEN_PROMPT

    rootOperator

    		Specifies an argument for the function of the root node of an expression.

    8217

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_SUB_ROOT_OPERATOR

    SAPVariableExclude

    		Specifies an argument to indicate an EXCLUDE sub-expression in the prompt answer for supporting SAP Variables. Its default value should be false, include, or 0 which means INCLUDE.

    8247

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_SAP_VARIABLE_EXCLUDE

    searchByNameButton

    		Specifies a user action to search objects by their names.

    8212

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_SEARCH_BY_NAME

    searchName

    		Specifies an argument for the searching name.

    8206

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_SEARCH_NAME

    searchRoot

    		Specifies an argument for the searching root.

    8207

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_SEARCH_ROOT

    submitAnswer

    		Specifies an argument to submit the prompt answer. The default value is 1 or true meaning to submit the prompt answer.

    8246

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_SUBMIT_ANSWER

    summary

    		Specifies a user action to show the prompt summary.

    8235

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_SHOW_SUMMARY

    textFileAnswer

    		Argument to specify a name for Text file which contains prompt answers.
    String parameter that represents the name of the file to be uploaded containing values to be used as prompt answers.
    It is a parameter for following event:
  • EnumPromptsBeanEvents.PROMPTS_EVENT_ANSWER_ALL_PROMPTS

    • 5010

    EnumPageEvents.WebEventArgumentTextFileAnswer

    toAttributeID

    		Specifies an argument for the drilled-to WebAttribute.

    8227

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_DRILL_TO_ATTRIBUTE_ID

    unitsToAdd

    		Specifies an argument for the prompt answer units to add. Depending on the prompt type, its value varies.

    8215

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_UNITS_TO_ADD

    unitsToRemove

    		Specifies an argument for the prompt answer units to remove.

    8216

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_UNITS_TO_REMOVE

    userStringSeparator

    		Specifies an argument for user specified string separator.

    8244

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_USER_SEPARATOR
    ProcessAnyPrompts
    Specifies an event to process any supported user action for any number of PromptObject contained in a PromptsBean.

    This event does exactly the same thing as another event EnumPromptsBeanEvents.PROMPTS_EVENT_PROCESS_ALL_PROMPTS, except that this event requires prompt positions and only processes those PromptObject whose positions are specified in the RequestKeys.

    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 EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_INCREMENTAL_FETCH, look for those arguments defined in the corresponding smaller event EnumPromptsBeanEvents.PROMPTS_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 EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_DIMENSION_ID is a required argument for the user action EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION.

    This event needs the following required arguments:

    and the following optional arguments:

    8015

    EnumPromptsBeanEvents.PROMPTS_EVENT_PROCESS_ANY_PROMPTS

    *position

    		Specifies an argument for prompt position, a non negative integer.

    8201

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

    addUnitsButton

    		Specifies a user action to add more prompt answer units.

    8208

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_ADD_UNITS

    alias

    		Option to rename the message of the resulting report or document.

    8254

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_MESSAGE_ALIAS

    answer

    		Specifies an argument for the prompt answer units.

    8214

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER

    answerButton

    		Specifies a user action to answer a prompt.

    8211

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_ANSWER_PROMPT

    answerFormat

    		Specifies an argument for the prompt answer format as in EnumPromptAnswerFormat. The default answer format is PromptAnswerFormatFlat.

    8218

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT

    answerOptions

    		Specifies an argument for answer options when dealing with null or empty answer in the RequestKeys.

    8237

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

    attributeId

    		Specifies an argument for a WebAttribute or a WebDimensionAttribute.

    8202

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID

    attributeIDWithFormID

    		Specifies an argument for a WebAttribute along with one of its WebAttributeForm, separated by EnumPromptsBeanEvents.UNIT_SEPARATOR.

    8229

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID_AND_FORM_ID

    blockBegin

    		Specifies an argument for block begin for incremental fetch.

    8204

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_BLOCK_BEGIN

    blockCount

    		Specifies an argument for block count for incremental fetch.

    8205

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_BLOCK_COUNT

    browseChildFolderButton

    		Specifies a user action to browse a child WebFolder.

    8226

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_CHILD_FOLDER

    browseElementButton

    		Specifies a user action to browse elements under an attribute.

    8213

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_ELEMENT

    browseParentFolderButton

    		Specifies a user action to browse a parent WebFolder.

    8238

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_PARENT_FOLDER

    browsePath

    		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.

    8240

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_BROWSE_PATH

    calendarButton

    		Specifies an argument to show the calendar button.

    8236

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_CALENDAR_BUTTON

    cancelButton

    		Specifies a user action to cancel answering a prompt.

    8210

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_CANCEL_PROMPT

    childFolderID

    		Specifies an argument for a child WebFolder.

    8225

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_CHILD_FOLDER_ID

    clearAndAddUnitsButton

    		Specifies a user action to clear the exsiting prompt answers and then add new ones.

    8228

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_CLEAR_EXISTING_AND_ADD_UNITS

    dimensionID

    		Specifies an argument for a dimension.

    8219

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_DIMENSION_ID

    drillWithinHierarchyButton

    		Specifies a user action to drill up and down within a hierarchy in a WebExpressionPrompt.

    8220

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_DRILL_WITHIN_HIERARCHY

    filterXml

    		Specifies an argument for a filter string used in element browsing.

    8203

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_FILTER_STRING

    funcVal

    		Specifies an argument for the funtion of an WebOperatorNode in a WebExpression.

    8222

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_FUNCTION

    gotoPageId

    		Specifies an argument to go to a particular page for incrementally fetching objects and elements.

    8253

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_INCREMENTAL_FETCH_GOTO_PAGE

    hiddenAttributeID

    		Specifies an argument for a hidden variable in HTML to save the highlighted WebAttribute or WebDimensionAttribute.

    8233

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_HIDDEN_ATTRIBUTE_ID

    hiddenDimensionID

    		Specifies an argument for a hidden variable in HTML to save the highlighted WebDimension.

    8232

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_HIDDEN_DIMENSION_ID

    highlightDimensionAttributeButton

    		Specifies a user action to highlight a WebDimensionAttribute in a WebExpressionPrompt.

    8221

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION_ATTRIBUTE

    highlightDimensionButton

    		Specifies a user action to highlight a WebDimension.

    8239

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION

    incrementalFetchButton

    		Specifies a user action to incrementally fetch WebDisplayUnit.

    8231

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_INCREMENTAL_FETCH

    loadFile

    		Argument to specify a name 'Load file' button.
    String value for this button.
    It is a parameter for following event:
  • EnumPromptsBeanEvents.PROMPTS_EVENT_ANSWER_ALL_PROMPTS

    • 5014

    EnumPageEvents.WebEventArgumentLoadFile

    matchCase

    		Specifies an argument for case-sensitive when building WebFilter.

    8234

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_MATCH_CASE

    metricID

    		Specifies an argument for a WebMetric.

    8223

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_METRIC_ID

    navigation

    		Specifies an argument for navigating through a PromptsBean.

    8230

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_NAVIGATION

    promptParentFolderID

    		Specifies an argument for a parent WebFolder.

    8224

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PARENT_FOLDER_ID

    removeUnitsButton

    		Specifies a user action to remove prompt answer units.

    8209

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_REMOVE_UNITS

    reOpenPrompt

    		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 is 1 or true, 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.

    8245

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_REOPEN_PROMPT

    rootOperator

    		Specifies an argument for the function of the root node of an expression.

    8217

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_SUB_ROOT_OPERATOR

    SAPVariableExclude

    		Specifies an argument to indicate an EXCLUDE sub-expression in the prompt answer for supporting SAP Variables. Its default value should be false, include, or 0 which means INCLUDE.

    8247

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_SAP_VARIABLE_EXCLUDE

    searchByNameButton

    		Specifies a user action to search objects by their names.

    8212

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_SEARCH_BY_NAME

    searchName

    		Specifies an argument for the searching name.

    8206

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_SEARCH_NAME

    searchRoot

    		Specifies an argument for the searching root.

    8207

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_SEARCH_ROOT

    submitAnswer

    		Specifies an argument to submit the prompt answer. The default value is 1 or true meaning to submit the prompt answer.

    8246

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_SUBMIT_ANSWER

    summary

    		Specifies a user action to show the prompt summary.

    8235

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ACTION_SHOW_SUMMARY

    textFileAnswer

    		Argument to specify a name for Text file which contains prompt answers.
    String parameter that represents the name of the file to be uploaded containing values to be used as prompt answers.
    It is a parameter for following event:
  • EnumPromptsBeanEvents.PROMPTS_EVENT_ANSWER_ALL_PROMPTS

    • 5010

    EnumPageEvents.WebEventArgumentTextFileAnswer

    toAttributeID

    		Specifies an argument for the drilled-to WebAttribute.

    8227

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_DRILL_TO_ATTRIBUTE_ID

    unitsToAdd

    		Specifies an argument for the prompt answer units to add. Depending on the prompt type, its value varies.

    8215

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_UNITS_TO_ADD

    unitsToRemove

    		Specifies an argument for the prompt answer units to remove.

    8216

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_UNITS_TO_REMOVE

    userStringSeparator

    		Specifies an argument for user specified string separator.

    8244

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_USER_SEPARATOR
    RemoveUnits
    Specifies an event to remove answer units from a PromptObject contained in a PromptsBean.

    This event applies to all types of WebPrompt. The argument EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_UNITS_TO_REMOVE holds the key, an integer number, of the answer unit to be removed.

    To remove a WebElement from a WebElementsObjectNode, users need to pass in the keys for both objects, separated by the EnumPromptsBeanEvents.ITEM_SEPARATOR.

    Same as the event EnumPromptsBeanEvents.PROMPTS_EVENT_ADD_UNITS, when removing units from prompt answer, this event also allows the users to change the function of root WebOperatorNode to either DssXmlFunctionAnd or DssXmlFunctionOr.

    This event needs the following required arguments:

    and the following optional arguments:

    8010

    EnumPromptsBeanEvents.PROMPTS_EVENT_REMOVE_UNITS

    *position

    		Specifies an argument for prompt position, a non negative integer.

    8201

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

    *unitsToRemove

    		Specifies an argument for the prompt answer units to remove.

    8216

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_UNITS_TO_REMOVE

    rootOperator

    		Specifies an argument for the function of the root node of an expression.

    8217

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_SUB_ROOT_OPERATOR
    SearchByName
    Specifies an event to search objects by specifying the searching name for a PromptObject contained in a PromptsBean.

    This event applies only to WebObjectsPrompt or WebDimtyPrompt. 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:

    8014

    EnumPromptsBeanEvents.PROMPTS_EVENT_SEARCH_BY_NAME

    *position

    		Specifies an argument for prompt position, a non negative integer.

    8201

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

    answer

    		Specifies an argument for the prompt answer units.

    8214

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER

    answerFormat

    		Specifies an argument for the prompt answer format as in EnumPromptAnswerFormat. The default answer format is PromptAnswerFormatFlat.

    8218

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT

    answerOptions

    		Specifies an argument for answer options when dealing with null or empty answer in the RequestKeys.

    8237

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

    blockBegin

    		Specifies an argument for block begin for incremental fetch.

    8204

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_BLOCK_BEGIN

    blockCount

    		Specifies an argument for block count for incremental fetch.

    8205

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_BLOCK_COUNT

    searchName

    		Specifies an argument for the searching name.

    8206

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_SEARCH_NAME

    searchRoot

    		Specifies an argument for the searching root.

    8207

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_SEARCH_ROOT
    ShowAllPromptsSummary
    Specifies an event to show summary of all PromptObject contained in a PromptsBean.

    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:

    8022

    EnumPromptsBeanEvents.PROMPTS_EVENT_SHOW_ALL_PROMPTS_SUMMARY

    answer

    		Specifies an argument for the prompt answer units.

    8214

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER

    answerFormat

    		Specifies an argument for the prompt answer format as in EnumPromptAnswerFormat. The default answer format is PromptAnswerFormatFlat.

    8218

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT

    answerOptions

    		Specifies an argument for answer options when dealing with null or empty answer in the RequestKeys.

    8237

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS
    ShowAnyPromptsSummary
    Specifies an event to show summary of any number of PromptObject contained in a PromptsBean.

    This event does exactly the same thing as another event EnumPromptsBeanEvents.PROMPTS_EVENT_PROCESS_ALL_PROMPTS, except that this event requires prompt positions and only processes those PromptObject whose positions are specified in the RequestKeys.

    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:

    8023

    EnumPromptsBeanEvents.PROMPTS_EVENT_SHOW_ANY_PROMPTS_SUMMARY

    *position

    		Specifies an argument for prompt position, a non negative integer.

    8201

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION

    answer

    		Specifies an argument for the prompt answer units.

    8214

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER

    answerFormat

    		Specifies an argument for the prompt answer format as in EnumPromptAnswerFormat. The default answer format is PromptAnswerFormatFlat.

    8218

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT

    answerOptions

    		Specifies an argument for answer options when dealing with null or empty answer in the RequestKeys.

    8237

    EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

    Notes

    * denotes required field.