Supported Bean: PageComponent

A PageComponent class instance represents the information regarding a page that can be handled by the Web Application. All the details required for displaying one page on the application is available from here.
It has a PageInfo class associated. This PageInfo contains the structure as defined in the pageConfig.xml Things like BeanList and Bean Properties are retrieved from here.

Event handler: com.microstrategy.web.app.beans.EnumSysBeanTypes.AppBeanPage (5)

Application bean type for the Page component

Events

browseFolder, cancelRepromptRequest, cancelRepromptRequestEvent, cancelRepromptRequestEvent, changeFolderViewMode, changeReport, changeSRViewmode, changeSubsViewMode, changeUserMgrViewmode, ProcessAllPrompts, ProcessAnyPrompts, refresh, resetState, setSaveFolderID, showBean, switchScreenMode, updateBoneProperty, updateBrowserSetting, updatePreference, updateSessionBrowserSetting

browseFolder

5004

folderID

3001

sysFolder

5006

cancelRepromptRequest
Event for canceling a reprompt request.

2048028

EnumRWBeanEvents.REPORT_WRITER_EVENT_CANCEL_REPROMPT_REQUEST
cancelRepromptRequestEvent
Specifies an event to cancel the request.

32006

EnumDocumentBeanEvents.DOCUMENT_EVENT_CANCEL_REPROMPT_REQUEST
cancelRepromptRequestEvent
Event for canceling a reprompt request.

4046

EnumReportBeanEvents.REPORT_EVENT_CANCEL_REPROMPT_REQUEST
changeFolderViewMode
Event to change the view mode of the folder content.

5002

EnumPageEvents.WebEventChangeFolderViewMode

folderViewMode

Argument to specify how Report is viewed, either as Grid or as Graph.
It is a parameter for following event:
  • EnumPageEvents.WebEventChangeFolderViewMode

    • 5002

    EnumPageEvents.WebEventArgumentFolderViewMode
    changeReport

    5001

    changeSRViewmode
    Event to update the view mode for security role elements

    5021

    EnumPageEvents.WebEventChangeSecurityRolesViewMode

    srViewMode

    		Argument to specify the view mode for security role elements

    5023

    EnumPageEvents.WebEventArgumentSecurityRolesViewMode
    changeSubsViewMode
    Event to change the view mode in the my subscriptions page.

    5009

    EnumPageEvents.WebEventChangeSubscriptionsViewMode

    _subsViewMode

    		Argument to specify view mode of Web Subscriptions.
    String parameter associated with EnumWebPreferences
    It is a parameter for following event:
  • EnumPageEvents.WebEventChangeSubscriptionsViewMode

    • 5008

    EnumPageEvents.WebEventArgumentSubscriptionsViewMode

    ncViewMode

    		Argument to specify view mode of narrowcast subscriptions.

    5009

    EnumPageEvents.WebEventArgumentNCSubscriptionsViewMode
    changeUserMgrViewmode
    Event to update the view mode for user manager elements

    5020

    EnumPageEvents.WebEventChangeUserManagerViewModeType

    umViewMode

    		Argument to specify values separator.
  • EnumPromptsBeanEvents.PROMPTS_EVENT_ANSWER_ALL_PROMPTS

    • 5022

    EnumPageEvents.WebEventArgumentLoadFileSeparator
    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

    		Argument to specify a name for 'Add unit' button.
    String value used in prompts. Represents the name of the image button.
    It is a parameter for following event:
  • EnumPromptsBeanEvents.PROMPTS_EVENT_ANSWER_ALL_PROMPTS

    • 5012

    EnumPageEvents.WebEventArgumentAddUnitButton

    answerButton

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

    • 5015

    EnumPageEvents.WebEventArgumentExecutePromptedReport

    answerFormat

    		Argument to specify a name for 'Add unit' button.
    String value used in prompts. Represents the name of the image button.
    It is a parameter for following event:
  • EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT

    • 5024

    EnumPageEvents.WebEventArgumentAnswerFormat

    answerOptions

    		Argument to specify a name for 'Add unit' button.
    String value used in prompts. Represents the name of the image button.
    It is a parameter for following event:
  • EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

    • 5025

    EnumPageEvents.WebEventArgumentAnswerOptions

    attributeIDWithFormID

    		Argument to specify an attribute and form Id values. String value composed of two IDs, for both attribute and form.
    codechange WebEventArgumentValueList was replaced with WebEventArgumentUnitsToAdd Also, made changes in entry found in appBeanEvents.xml where was replaced with

    5011

    EnumPageEvents.WebEventArgumentAttributeIdFormId

    clearAndAddUnitsButton

    		Argument to specify the view mode for security role elements

    5023

    EnumPageEvents.WebEventArgumentSecurityRolesViewMode

    funcVal

    		Argument to specify a name for a Prompt function.
    String value for prompt function used to group prompt answers in file. Function gets changed to 'In' for this case.
    It is a parameter for following event:
  • EnumPromptsBeanEvents.PROMPTS_EVENT_ANSWER_ALL_PROMPTS

    • 5016

    EnumPageEvents.WebEventArgumentPromptFunction

    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

    reportDesignMode

    		Argument to specify report's execution mode.
    This parameter is a String representation for an int value. It's used to determine how the report will be executed. Report has different behavior depending upon what execution mode is set, hence, permissions and functionality differs among these modes. Argument is used in following event:
  • EnumServletEvents.WebEventEditReport
    The available int values for this parameter are specified in EnumReportViewModes

    • 3017

    EnumServletEvents.WebEventArgumentReportDesignMode

    saveAs

    		Argument to specify whether or not to first apply changes to Report Bean.
    Parameter for a String representation of a boolean value. Argument used in following event:
  • EnumServletEvents.WebEventSaveAs
    Usage:
  • 'false' : don't apply changes first.
  • 'true' : apply changes first.

    • 3013

    EnumServletEvents.WebEventArgumentApplyChangesFirst

    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

    unitsToAdd

    		Argument to specify a name for Units selection to be add to prompt answer.
    String value for available list name, normally displayed as a list box. This list displays all available objects to be used as part of the prompt answer.
    It is a parameter for following event:
  • EnumPromptsBeanEvents.PROMPTS_EVENT_ANSWER_ALL_PROMPTS

    • 5013

    EnumPageEvents.WebEventArgumentUnitsToAdd

    userStringSeparator

    		Argument to specify values separator.
  • EnumPromptsBeanEvents.PROMPTS_EVENT_ANSWER_ALL_PROMPTS

    • 5022

    EnumPageEvents.WebEventArgumentLoadFileSeparator
    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

    addUnitsButton

    		Argument to specify a name for 'Add unit' button.
    String value used in prompts. Represents the name of the image button.
    It is a parameter for following event:
  • EnumPromptsBeanEvents.PROMPTS_EVENT_ANSWER_ALL_PROMPTS

    • 5012

    EnumPageEvents.WebEventArgumentAddUnitButton

    answerButton

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

    • 5015

    EnumPageEvents.WebEventArgumentExecutePromptedReport

    answerFormat

    		Argument to specify a name for 'Add unit' button.
    String value used in prompts. Represents the name of the image button.
    It is a parameter for following event:
  • EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT

    • 5024

    EnumPageEvents.WebEventArgumentAnswerFormat

    answerOptions

    		Argument to specify a name for 'Add unit' button.
    String value used in prompts. Represents the name of the image button.
    It is a parameter for following event:
  • EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS

    • 5025

    EnumPageEvents.WebEventArgumentAnswerOptions

    attributeIDWithFormID

    		Argument to specify an attribute and form Id values. String value composed of two IDs, for both attribute and form.
    codechange WebEventArgumentValueList was replaced with WebEventArgumentUnitsToAdd Also, made changes in entry found in appBeanEvents.xml where was replaced with

    5011

    EnumPageEvents.WebEventArgumentAttributeIdFormId

    clearAndAddUnitsButton

    		Argument to specify the view mode for security role elements

    5023

    EnumPageEvents.WebEventArgumentSecurityRolesViewMode

    funcVal

    		Argument to specify a name for a Prompt function.
    String value for prompt function used to group prompt answers in file. Function gets changed to 'In' for this case.
    It is a parameter for following event:
  • EnumPromptsBeanEvents.PROMPTS_EVENT_ANSWER_ALL_PROMPTS

    • 5016

    EnumPageEvents.WebEventArgumentPromptFunction

    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

    reportDesignMode

    		Argument to specify report's execution mode.
    This parameter is a String representation for an int value. It's used to determine how the report will be executed. Report has different behavior depending upon what execution mode is set, hence, permissions and functionality differs among these modes. Argument is used in following event:
  • EnumServletEvents.WebEventEditReport
    The available int values for this parameter are specified in EnumReportViewModes

    • 3017

    EnumServletEvents.WebEventArgumentReportDesignMode

    saveAs

    		Argument to specify whether or not to first apply changes to Report Bean.
    Parameter for a String representation of a boolean value. Argument used in following event:
  • EnumServletEvents.WebEventSaveAs
    Usage:
  • 'false' : don't apply changes first.
  • 'true' : apply changes first.

    • 3013

    EnumServletEvents.WebEventArgumentApplyChangesFirst

    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

    unitsToAdd

    		Argument to specify a name for Units selection to be add to prompt answer.
    String value for available list name, normally displayed as a list box. This list displays all available objects to be used as part of the prompt answer.
    It is a parameter for following event:
  • EnumPromptsBeanEvents.PROMPTS_EVENT_ANSWER_ALL_PROMPTS

    • 5013

    EnumPageEvents.WebEventArgumentUnitsToAdd

    userStringSeparator

    		Argument to specify values separator.
  • EnumPromptsBeanEvents.PROMPTS_EVENT_ANSWER_ALL_PROMPTS

    • 5022

    EnumPageEvents.WebEventArgumentLoadFileSeparator
    refresh
    Event to refresh the current page.

    5005

    EnumPageEvents.WebEventRefresh

    evtOrigin

    		Argument to specify where the refresh event is triggered from. It is a parameter for the following event:
  • EnumPageEvents.WebEventRefresh

    • 5030

    EnumPageEvents.WebEventArgumentRefreshOrigin
    resetState
    resets the stateID

    4048

    EnumReportBeanEvents.REPORT_EVENT_RESET_STATE
    setSaveFolderID
    Event to set the default folder ID where reports and documents are saved.
    When set, this will remain set as long as the session is valid.

    5027

    EnumPageEvents.WebEventSetSaveFolderID

    saveFolderID

    		Argument to specify the default folder ID where reports and documents are saved.
    It is a parameter for following event:
  • EnumPageEvents.WebEventSetSaveFolderID

    • 5029

    EnumPageEvents.WebEventArgumentSaveFolderID
    showBean
    Event to show/hide modal app beans.

    5010

    EnumPageEvents.WebEventShowBean

    bean

    		Argument to specify the name of a bean within the hierarchy

    5018

    EnumPageEvents.WebEventArgumentBean

    props

    		Argument to specify a name for 'Add unit' button.
    String value used in prompts. Represents the name of the image button.
    It is a parameter for following event:
  • EnumPromptsBeanEvents.PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT

    • 5024

    EnumPageEvents.WebEventArgumentAnswerFormat

    show

    		Argument to specify whether to show or to hide a modal bean

    5017

    EnumPageEvents.WebEventArgumentShowBean
    switchScreenMode
    Event to switch between full screen mode and normal screen mode.

    5026

    EnumPageEvents.WebEventSwitchScreenMode

    screenMode

    		Argument to specify the screen mode to be displayed in the application

    5028

    EnumPageEvents.WebEventArgumentScreenMode
    updateBoneProperty
    Event to update the boneProperty in user's preference

    5019

    EnumPageEvents.WebEventUpdateBoneProperty

    boneHeight

    		Argument to specify the height of the bone

    5021

    EnumPageEvents.WebEventArgumentBoneHeight

    boneName

    		Argument to specify the name of the bone

    5019

    EnumPageEvents.WebEventArgumentBoneName

    boneWidth

    		Argument to specify the width of the bone

    5020

    EnumPageEvents.WebEventArgumentBoneWidth
    updateBrowserSetting
    Event to modify a browser setting.

    5008

    EnumPageEvents.WebEventSetPermanentBrowserSetting

    name

    		Argument to specify name of browser setting.
    String parameter associated with EnumWebBrowserSettings
    It is a parameter for following event:
  • EnumPageEvents.WebEventSetPermanentBrowserSetting

    • 5005

    EnumPageEvents.WebEventArgumentBrowserSettingName

    value

    		Argument to specify a value of a given browser setting.
    String parameter that represents a value to be assigned to a browser setting defined by WebEventArgumentBrowserSettingName.
    It is a parameter for following event:
  • EnumPageEvents.WebEventSetPermanentBrowserSetting

    • 5007

    EnumPageEvents.WebEventArgumentBrowserSettingValue
    updatePreference
    Event to update user's preference.

    5003

    EnumPageEvents.WebEventUpdatePreference

    prefName

    		Argument to specify the name of the Preference to be updated.

    5003

    EnumPageEvents.WebEventArgumentPrefName

    prefValue

    		Argument to specify a value for given Preference.

    5004

    EnumPageEvents.WebEventArgumentPrefValue
    updateSessionBrowserSetting
    Event to modify a HTTP Session browser setting.

    5028

    EnumPageEvents.WebEventSetSessionBrowserSetting

    name

    		Argument to specify name of browser setting.
    String parameter associated with EnumWebBrowserSettings
    It is a parameter for following event:
  • EnumPageEvents.WebEventSetPermanentBrowserSetting

    • 5005

    EnumPageEvents.WebEventArgumentBrowserSettingName

    value

    		Argument to specify a value of a given browser setting.
    String parameter that represents a value to be assigned to a browser setting defined by WebEventArgumentBrowserSettingName.
    It is a parameter for following event:
  • EnumPageEvents.WebEventSetPermanentBrowserSetting

    • 5007

    EnumPageEvents.WebEventArgumentBrowserSettingValue

    Notes

    * denotes required field.