Package com.microstrategy.web.app.beans

Interface EnumDrillEditorEvents

All Superinterfaces:

EnumPageEvents, EnumServletEvents

public interface EnumDrillEditorEvents
extends EnumPageEvents

All event definitions used in drill editor bean

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields

Modifier and Type	Field	Description
static int	WebEventAdvDrillEditorProcess	This event is used for two purposes.
static int	WebEventArgumentAdvDrillAttributeDrillPaths	Argument to specify the drill key for the advanced drill editor.
static int	WebEventArgumentAdvDrillChangeDimensionImageName	Argument to specify the name of the image used to show the change dimension button on the Advanced Drill Editor.
static int	WebEventArgumentAdvDrillDimensionName	Argument to specify the name of the dimentsion for the Advanced Drill Editor.
static int	WebEventArgumentAdvDrillSubmitImageName	Argument to specify the name of the image used to show the process advanced drill button on the Advanced Drill Editor.
static int	WebEventArgumentDrillElementList	Argument to specify the list of elements on which the user wants to filter the drill.
static int	WebEventArgumentDrillImageName	Argument to specify the name of the check box image on the drill editor.
static int	WebEventArgumentDrillKeepParent	Argument to specify if we need to keep the parent element after drilling.
static int	WebEventArgumentDrillKey	Argument to specify the drill key for Drill Editor.
static int	WebEventArgumentOptimizedDrillPathInfo	Argument to specify the drill path key passed in optimized format.
static int	WebEventDrillEditorProcess	Event to process the Drill Editor Form.

Fields inherited from interface com.microstrategy.web.app.beans.EnumPageEvents

WebEventArgumentAddUnitButton, WebEventArgumentAnswerFormat, WebEventArgumentAnswerOptions, WebEventArgumentAttributeIdFormId, WebEventArgumentBean, WebEventArgumentBoneHeight, WebEventArgumentBoneName, WebEventArgumentBoneWidth, WebEventArgumentBrowserSettingName, WebEventArgumentBrowserSettingValue, WebEventArgumentClearExistinAndAddUnitsButton, WebEventArgumentExecutePromptedReport, WebEventArgumentFolderViewMode, WebEventArgumentLoadFile, WebEventArgumentLoadFileSeparator, WebEventArgumentNCSubscriptionsViewMode, WebEventArgumentPrefName, WebEventArgumentPrefValue, WebEventArgumentPromptFunction, WebEventArgumentRefreshOrigin, WebEventArgumentSaveFolderID, WebEventArgumentScreenMode, WebEventArgumentSecurityRolesViewMode, WebEventArgumentShowBean, WebEventArgumentShowBeanProperties, WebEventArgumentSubscriptionsViewMode, WebEventArgumentTextFileAnswer, WebEventArgumentUnitsToAdd, WebEventArgumentUserManagerViewModeType, WebEventChangeFolderViewMode, WebEventChangeSecurityRolesViewMode, WebEventChangeSubscriptionsViewMode, WebEventChangeUserManagerViewModeType, WebEventRefresh, WebEventSetPermanentBrowserSetting, WebEventSetSaveFolderID, WebEventSetSessionBrowserSetting, WebEventShowBean, WebEventSwitchScreenMode, WebEventUpdateBoneProperty, WebEventUpdatePreference

Fields inherited from interface com.microstrategy.web.app.beans.EnumServletEvents

RWebEventArgumentIMPORTAFTERSAVE, WebEventAddCacheSubscription, WebEventAddInboxSubscription, WebEventAddMobileSubscription, WebEventAddPersonalViewSubscription, WebEventAddSubscription, WebEventAdminOpenHome, WebEventArgumentActionType, WebEventArgumentAdvancedOption, WebEventArgumentAllowExecute, WebEventArgumentAnalysisAddMode, WebEventArgumentAnalysisID, WebEventArgumentApplyChangesFirst, WebEventArgumentAuthenticationMode, WebEventArgumentBeansState, WebEventArgumentCheckLogin, WebEventArgumentClearPage, WebEventArgumentConvertDashboardToDoc, WebEventArgumentCubeName, WebEventArgumentCubeReportId, WebEventArgumentDocumentID, WebEventArgumentDocumentViewMode, WebEventArgumentDrillDisplayMode, WebEventArgumentDrillFilterOnPageBy, WebEventArgumentDrillGraphPixelX, WebEventArgumentDrillGraphPixelY, WebEventArgumentDrillPathKey, WebEventArgumentDrillRetainParent, WebEventArgumentDrillRetainThreshold, WebEventArgumentEventToForwardTo, WebEventArgumentExportDefaultRunMode, WebEventArgumentExportExpandPageByFields, WebEventArgumentexportFilterDetails, WebEventArgumentExportFormatNameGraphs, WebEventArgumentExportFormatNameGrids, WebEventArgumentExportFromOptions, WebEventArgumentExportHeadersAsText, WebEventArgumentExportMetricValuesAsText, WebEventArgumentExportOfficeRefresh, WebEventArgumentExportOverlapGridTitles, WebEventArgumentExportSection, WebEventArgumentExportTextDelimiter, WebEventArgumentExportUseLiveChartGraphs, WebEventArgumentExportUseSeparateSheets, WebEventArgumentFacebookToken, WebEventArgumentFastExportLink, WebEventArgumentFolderId, WebEventArgumentFolderName, WebEventArgumentFolderType, WebEventArgumentFromPageHistory, WebEventArgumentGraphHeight, WebEventArgumentGraphRequestId, WebEventArgumentGraphShrinkHeight, WebEventArgumentGraphShrinkWidth, WebEventArgumentGraphWidth, WebEventArgumentIgnoreGraphHeightWidth, WebEventArgumentIsAdminHelp, WebEventArgumentIsContinueForm, WebEventArgumentIsCubeEdit, WebEventArgumentIsCubeRepublish, WebEventArgumentIsFFSQL, WebEventArgumentIsFromPrompt, WebEventArgumentIsNew, WebEventArgumentIsNewAnalysis, WebEventArgumentLoginMode, WebEventArgumentMenuID, WebEventArgumentMenuOptionID, WebEventArgumentMessage, WebEventArgumentMessageID, WebEventArgumentNodeKey, WebEventArgumentNotAskExportOptions, WebEventArgumentObjectID, WebEventArgumentObjectType, WebEventArgumentParentFolderId, WebEventArgumentPDFAdminFooterFile, WebEventArgumentPDFAdminHeaderFile, WebEventArgumentPDFCoverPageFilterDetails, WebEventArgumentPDFExpandPageByFields, WebEventArgumentPDFExportFilename, WebEventArgumentPDFExportSection, WebEventArgumentPDFFitToPagesTall, WebEventArgumentPDFFitToPagesWide, WebEventArgumentPDFFooterCenterSection, WebEventArgumentPDFFooterLeftSection, WebEventArgumentPDFFooterRightSection, WebEventArgumentPDFHeaderCenterSection, WebEventArgumentPDFHeaderLeftSection, WebEventArgumentPDFHeaderRightSection, WebEventArgumentPDFMarginSizeBottom, WebEventArgumentPDFMarginSizeLeft, WebEventArgumentPDFMarginSizeRight, WebEventArgumentPDFMarginSizeTop, WebEventArgumentPDFMaxCells, WebEventArgumentPDFMaxFooterSize, WebEventArgumentPDFMaxHeaderSize, WebEventArgumentPDFOutlineModeState, WebEventArgumentPDFPaperOrientationOption, WebEventArgumentPDFPaperSize, WebEventArgumentPDFScalingOption, WebEventArgumentPDFShowOptions, WebEventArgumentPDFShrinkFontPercentage, WebEventArgumentPortNumber, WebEventArgumentPreferenceGroup, WebEventArgumentPreferenceGroupSet, WebEventArgumentPreferenceTransform, WebEventArgumentPrintAdminFooterFile, WebEventArgumentPrintAdminHeaderFile, WebEventArgumentPrintCoverPageFilterDetails, WebEventArgumentPrintDefaultColsPerPage, WebEventArgumentPrintDefaultRowsPerPage, WebEventArgumentPrintDisplayPopupPrintDialog, WebEventArgumentPrintExpandPagebyFields, WebEventArgumentPrintFitColsToPage, WebEventArgumentPrintFitRowsToPage, WebEventArgumentPrintFooterCenterSection, WebEventArgumentPrintFooterLeftSection, WebEventArgumentPrintFooterRightSection, WebEventArgumentPrintGridColsPerPage, WebEventArgumentPrintGridGraphSamePage, WebEventArgumentPrintGridRowsPerPage, WebEventArgumentPrintHeaderCenterSection, WebEventArgumentPrintHeaderLeftSection, WebEventArgumentPrintHeaderRightSection, WebEventArgumentPrintMarginSizeBottom, WebEventArgumentPrintMarginSizeLeft, WebEventArgumentPrintMarginSizeRight, WebEventArgumentPrintMarginSizeTop, WebEventArgumentPrintMaxCellsPerBlock, WebEventArgumentPrintMaxColsPerPage, WebEventArgumentPrintMaxFooterSize, WebEventArgumentPrintMaxGraphsPerBlock, WebEventArgumentPrintMaxHeaderSize, WebEventArgumentPrintMaxRowsPerPage, WebEventArgumentPrintOpenNewWindow, WebEventArgumentPrintPaperOrientationOption, WebEventArgumentPrintPaperSize, WebEventArgumentPrintScalingOption, WebEventArgumentPrintShowOptionsOnPrint, WebEventArgumentPrintShrinkFontPercentage, WebEventArgumentProjectName, WebEventArgumentPromptExpressionType, WebEventArgumentPromptStyle, WebEventArgumentQueryBuild, WebEventArgumentRelativePageNumber, WebEventArgumentReportDesignMode, WebEventArgumentReportFilterID, WebEventArgumentReportParentFolderID, WebEventArgumentReportStateID, WebEventArgumentReportTemplateID, WebEventArgumentReportViewMode, WebEventArgumentRWCreationFlags, WebEventArgumentRWCreationTemplateID, WebEventArgumentRWExecutionMode, WebEventArgumentRWExportMode, WebEventArgumentRWPageByElements, WebEventArgumentRWViewMode, WebEventArgumentSaveAsOrigin, WebEventArgumentSaveAsOriginPath, WebEventArgumentSaveAsShowContinueButton, WebEventArgumentScheduleEditMode, WebEventArgumentSearchDomain, WebEventArgumentSearchString, WebEventArgumentServerAlias, WebEventArgumentServerName, WebEventArgumentSessionKey, WebEventArgumentShow, WebEventArgumentShowDefault, WebEventArgumentShowOptionsPage, WebEventArgumentShowServerProperties, WebEventArgumentSliceId, WebEventArgumentSourceId, WebEventArgumentSourceType, WebEventArgumentSubPage, WebEventArgumentSubscriptionDeliveryMode, WebEventArgumentSubscriptionID, WebEventArgumentTarget, WebEventArgumentTreeType, WebEventArgumentTriggerID, WebEventArgumentTwoStepVerificationCode, WebEventArgumentUpdateParentWindow, WebEventArgumentUserId, WebEventArgumentUserName, WebEventArgumentUserPassword, WebEventCallChangePassword, WebEventCancel, WebEventCloseDashboardPage, WebEventCreateBlankVI, WebEventCreateHTML5VI, WebEventCreateOptimizedVI, WebEventCreatePrompt, WebEventCreateSecurityRole, WebEventCreateUser, WebEventCreateUserGroup, WebEventDashboardPublishWizard, WebEventDeleteHistoryList, WebEventDeleteObject, WebEventDisplayError, WebEventDrillToFixedTemplateFromDocToReport, WebEventEditCacheSubscription, WebEventEditInboxSubscription, WebEventEditMobileSubscription, WebEventEditPersonalViewSubscription, WebEventEditPrompt, WebEventEditReport, WebEventEditRW, WebEventEditSecurityRole, WebEventEditSubscription, WebEventEditUser, WebEventEditUserGroup, WebEventExecuteHTML5VI, WebEventExecuteMojoIVE, WebEventExecuteRWDocumentHeavy, WebEventExportSaveReportProperties, WebEventFastDocumentExport, WebEventFastExport, WebEventFastPDFExport, WebEventForwardToRWExport, WebEventGeneric, WebEventGetDocumentDetails, WebEventGetReportDetails, WebEventGetRWDocumentDetails, WebEventGraphDrillFromDocToReport, WebEventGridDrillFromDocToReport, WebEventHTMLMenu, WebEventInitializeHTML5VIFromSubscription, WebEventIPadAnnotation, WebEventLoadGraph, WebEventLogout, WebEventNCAddFileSubscription, WebEventNCAddFTPSubscription, WebEventNCAddPrintSubscription, WebEventNCAddresses, WebEventNCAddSubscription, WebEventNCEditFileSubscription, WebEventNCEditFTPSubscription, WebEventNCEditPrintSubscription, WebEventNCEditSubscription, WebEventNCFileAddresses, WebEventNCFTPAddresses, WebEventNCOpenDeleteAddress, WebEventNCPrintAddresses, WebEventNCSendNow, WebEventNCSendNowConfirm, WebEventNCSubsConfirm, WebEventOpenAbout, WebEventOpenAdminFAQs, WebEventOpenAdminHelp, WebEventOpenAdminHelpIndex, WebEventOpenCreate, WebEventOpenCreateDocument, WebEventOpenCreatePromptPage, WebEventOpenDefaultDesktop, WebEventOpenDefaultHomePage, WebEventOpenDesktop, WebEventOpenDiagnostics, WebEventOpenExport, WebEventOpenExportDocument, WebEventOpenExportOptions, WebEventOpenExportOptionsFromReport, WebEventOpenFAQs, WebEventOpenFilterEditor, WebEventOpenHelp, WebEventOpenHelpIndex, WebEventOpenHelpSetup, WebEventOpenHistoryList, WebEventOpenHistoryPage, WebEventOpenHome, WebEventOpenImportWizard, WebEventOpenImportWizardEntryPage, WebEventOpenIPAConfiguration, WebEventOpenIPAMonitor, WebEventOpenMyPage, WebEventOpenMyReports, WebEventOpenMySubscriptions, WebEventOpenObjectSubscriptions, WebEventOpenOfficeSetup, WebEventOpenOptimizedVI, WebEventOpenPage, WebEventOpenPDFOptions, WebEventOpenPDFOptionsFromReport, WebEventOpenPDFSaveReportProperties, WebEventOpenPreferences, WebEventOpenPrint, WebEventOpenPrintDocument, WebEventOpenPrintOptions, WebEventOpenPrintOptionsFromReport, WebEventOpenPrintSaveReportProperties, WebEventOpenQBuilder, WebEventOpenRRAccountSetting, WebEventOpenRRQuoteAcceptanceForm, WebEventopenRRUserImport, WebEventOpenRRUserManagement, WebEventOpenSaveReportProperties, WebEventOpenSchedule, WebEventOpenSearch, WebEventOpenSecurityRolesFolder, WebEventOpenSecuritySetup, WebEventOpenSharedReports, WebEventOpenSubscriptionEngineSetup, WebEventOpenSummary, WebEventOpenTopLevelUserGroups, WebEventOpenWizard, WebEventPDFDisplay, WebEventPrefColorPalette, WebEventPrefDynamicAddresseList, WebEventProcessLogin, WebEventQuickLogout, WebEventReportFlashExport, WebEventReportWritingDocumentPDFExport, WebEventReportWritingDocumentPDFFastExport, WebEventReturnTo, WebEventRunSearch, WebEventRWDHTMLExport, WebEventRWExport, WebEventRWSaveAs, WebEventSaveAs, WebEventSelectFilter, WebEventSelectTemplate, WebEventTakeMeHome, WebOpenAnalysis, WebOpenPrefChangePwdPage

Field Detail

WebEventDrillEditorProcess

static final int WebEventDrillEditorProcess

Event to process the Drill Editor Form.

See Also:

Constant Field Values

WebEventAdvDrillEditorProcess

static final int WebEventAdvDrillEditorProcess

This event is used for two purposes.
It is used to process the Advanced Drill Editor Form and it is also used to change the dimension shown in the Advanced Drill Editor. Based on whether the user has clicked on the chnage dimension button or process Advanced Drill button, we will decide which event to process.

See Also:

Constant Field Values

WebEventArgumentDrillKey

static final int WebEventArgumentDrillKey

Argument to specify the drill key for Drill Editor. This argument is made up of 4 different arguments and has a structure associated with it. These arguments are seperated by a seperator which is defined in EnumReportBeanEvents.DRILL_TO_KEY_SEPARATOR.
Usage:
The drill key is made up of four different arguments. Axis - The first argument is the axis of the template unit on which the user wants to drill. Allowed values are specified in EnumDSSXMLAxisName
Position - The second argument is the position of the template unit within the axis. This value is 1-based
Ordinal - The third argument is the ordinal of the template unit.
DrillPathID - The fourth argument is the Drill Path ID of the template unit.

See Also:

Constant Field Values

WebEventArgumentDrillElementList

static final int WebEventArgumentDrillElementList

Argument to specify the list of elements on which the user wants to filter the drill. The list of elements is seperated by a seperator as specified in EnumReportBeanEvents.METRIC_ELEM_LIST_SEPARATOR. The Id of the element is retrieved from WebHeader.

See Also:

Constant Field Values

WebEventArgumentDrillKeepParent

static final int WebEventArgumentDrillKeepParent

Argument to specify if we need to keep the parent element after drilling. The value for Retain Parent is specified in EnumReportBeanEvents.DRILL_RETAIN_PARENT

See Also:

Constant Field Values

WebEventArgumentDrillImageName

static final int WebEventArgumentDrillImageName

Argument to specify the name of the check box image on the drill editor. On the drill editor we show all the drill paths for all the titles and each drill is specified with a check image next to it. This image name is used to know which check image the user clicked on, which in turn is used to determine the corresponding drill action.

See Also:

Constant Field Values

WebEventArgumentAdvDrillDimensionName

static final int WebEventArgumentAdvDrillDimensionName

Argument to specify the name of the dimentsion for the Advanced Drill Editor. This argument is used for changing the dimension shown in the Advanced Drill Editor. The Advanced Drill Editor will show all the drill paths corresponding the dimension shown.

See Also:

Constant Field Values

WebEventArgumentAdvDrillChangeDimensionImageName

static final int WebEventArgumentAdvDrillChangeDimensionImageName

Argument to specify the name of the image used to show the change dimension button on the Advanced Drill Editor.
If this argument is present in the request keys we will process the change dimension event. This argument will be present in the request keys only if the user clicks on it.

See Also:

Constant Field Values

WebEventArgumentAdvDrillSubmitImageName

static final int WebEventArgumentAdvDrillSubmitImageName

Argument to specify the name of the image used to show the process advanced drill button on the Advanced Drill Editor.
If this argument is present in the request keys we will process the advanced drill event. This argument will be present in the request keys only if the user clicks on it.

See Also:

Constant Field Values

WebEventArgumentAdvDrillAttributeDrillPaths

static final int WebEventArgumentAdvDrillAttributeDrillPaths

Argument to specify the drill key for the advanced drill editor. This argument is made up of 5 different arguments and has a structure associated with it. These arguments are comma "," seperated.
Usage:
The drill key is made up of five different arguments.
Axis - The first argument is the axis of the template unit on which the user wants to drill. Allowed values are specified in EnumDSSXMLAxisName
Position - The second argument is the position of the template unit within the axis. This value is 1-based
Ordinal - The third argument is the ordinal of the template unit.
DrillPathID - The fourth argument is the Drill Path ID of the template unit.
Retain Thresholds - The fifth argument specifies if we need to retain thresholds after drilling. A value of "1" is used to denote Retain Thresholds.

See Also:

Constant Field Values

WebEventArgumentOptimizedDrillPathInfo

static final int WebEventArgumentOptimizedDrillPathInfo

Argument to specify the drill path key passed in optimized format. This argument should be used to pass the key obtained from the optimized drill path framework. If drill key corresponds to the old framework use WebEventArgumentDrillKey instead. This argument is made up of 2 different arguments and has a structure associated with it. These arguments are seperated by a seperator which is defined in EnumReportBeanEvents.DRILL_TO_KEY_SEPARATOR.
Usage:
The drill key is made up of two different arguments. Drill Path Key - This should be the key for the drill path that can be obtained using WebDrillPath.getKey()
Retain Thresholds - The second argument specifies if we need to retain thresholds after drilling. A value of "1" is used to denote Retain Thresholds. 0 specifies not to retain thresholds. Any other value instructs to use the value from the report definition.

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values