EnumServletEvents

Event to add a cache subscription

Event to add a subscription to the history list

Event to add a mobile subscription

Event to open a page for adding a subscription.

Event for opening 'Home' page for given Web Administration section.

Specifies the type of action (ACTION_TYPE_PDF, ACTION_TYPE_PRINT, ACTION_TYPE_EXPORT) Used in following event:

Argument to enable 'Advanced' option in OpenSearch event.
String value that represents a boolean value. This argument indicates OpenSearch to enable 'Advance' searching. It's used in following event:

Argument to specify whether to allow execution of a Report or Document in 'Details' page.
String representation of an int value used in following event:

Indicates how DI will return to the Analysis page. 1 - Add, 2 - replace, 3 - replace all

The Analysis Object ID

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:

Argument to specify the authentication mode when logging in.
String parameter for representing hexadecimal values defined in EnumDSSXMLAuthModes.
Used by following event:

Argument to specify the State of the Beans of current page.
This String argument is used keep bean's states between previous and current pages.
Used in following event:

Argument to indicate that accessing login page is part of the normal page flow.
String parameter to represent a boolean value. This argument enforces the application to display Login page before displaying a given page.
Used in following event:

Flag indicating we are performing a conversion from VI Dashboard to RS Document

Indicates the cube name

Argument to specify the document view mode. Value expected comes from the EnumWebDocumentViewMode enumeration Used in following event:

Specifies the display mode. A value from the enumeration EnumDSSXMLDisplayMode Used in following event:

Argument to specify element list to filter on while drilling.
Used in following event:

Argument specifying whether to filter on the Page By axis during drilling. Used in following event:

Specifies the X pixel offset for graph drill Used in following event:

Specifies the Y pixel offset for graph drill Used in following event:

Argument to specify drill path key.
Used in following event:

Specifies whether the parent should be kept after performing the drill operation. Used in following event:

specifies whether the thresholds should be kept after performing the drill operation. Used in following event:

Specifies the event to forward to after saving the report properties on the save report properties page. Used in following event:

Argument to specify whether to expand the page by fields when exporting to Excel with formatting. Used in following event:

Argument to specify the export format name for graphs. Used in following event:

Argument to specify the export format name for grids. Used in following event:

Argument to specify whether the Export page is opened from the Export options page.
String value that determines where the Export page is opened.
Used in following event:

Argument to specify whether to export the headers as text when exporting to Excel. Used in following event:

Argument to specify whether to export the metric values as text when exporting to Excel. Used in following event:

Argument to specify whether to allow MicroStrategy Office to refresh Reports after exporting to Excel with formatting. Used in following event:

Argument to specify whether to overlap grid titles when exporting to Excel with formatting. Used in following event:

Argument to specify what section to export. A value from EnumExportSection. Used in following event:

Argument to specify the text delimiter for exporting to Plaintext. Used in following event:

Argument to specify whether to use live chart for graphs when exporting to Excel with formatting. Used in following event:

Argument to specify whether to use separate pages when exporting to Excel with formatting. Used in following event:

Argument to specify the Facebook access token when logging in.
Used by following event:

Argument to specify whether the current action is a fast export request Used in following events:

Folder Name info for the Folder QuickSearch in order to pass the folder name to new search page

Argument to specify current folder Type.
This argument is a String representation of a folder type and it's used as argument in following event:

Indicates that the page is opened from the page history (back/forward buttons)

Argument to specify the height of a report graph.
String value for representing an int value.
Used by following event:

Argument to specify the size for shrinking the height of a report graph.
String value for representing an int value.
Used by following event:

Argument to specify the size for shrinking the width of a report graph.
String value for representing an int value.
Used by following event:

Argument to specify the with of a report graph.
String value for representing an int value.
Used by following event:

Argument to specify whether the graph height and width is to be set or igonred on the web graph obeject. This will be typically set to true if the graph is being loaded from a HTML document.
Used in following event:

Used in following event:

Whether we are editing a cube

Whether we are republishing a cube

Indicates whether DI will launch in FFSQL mode directly

A boolean argument to indicate whether we save from prompting stage. If this argument is missing, we treat it as false.

Argument to specify the identifier of the cube report Used in following event:

Indicates whether DI will launch the IVE editor directly

Argument to specify the login mode when logging in.
String parameter for representing hexadecimal values defined in EnumWebLoginModes.
Used by following event:

Argument to specify menu prefix identifier when handling menu events in HTML mode.
String representation value, which represents the Id of a Report menu to be manipulated. Used in following event:

Argument to specify menu option prefix identifier when handling menu events in HTML mode.
String representation value, which represents the Id of a sub menu option to be manipulated. Used in following event:

Argument to specify a Message ID for editing a given Report.
This argument is a String representation of a Message ID and it's used as argument in following events:

Specifies node key of the grid object for filter on selections from doc to report Used in following event:

Argument to indicate whether or not to prompt again for 'Export options'.
String parameter to display these preferences to end user.
It's used in following event:

Argument to specify the object ID as parameter in servlet events.
This argument is a String representation of an Object Id and it's used as argument for the following events:

Argument to specify an object type as parameter in servlet events.
This argument is a String representation of an Object type and it's used as argument for the following events:

Argument to specify the path to the Administrator's footer file. Used in following event:

Argument to specify the path to the Administrator's header file. Used in following event:

Argument to specify whether to display a cover page with the filter details when printing.
String value that represents a boolean value.
Used in following event:

Argument to specify whether to expand the page-by fields. Used in following event:

Argument to specify the PDF file name to use in exporting servlet events.
A String value parameter that represents the name of the PDF file.
It's used in following event:

Argument to specify the section to export to PDF. The value for this parameter is defined in EnumExportSection.
Used in following event:

Argument to specify how many pages tall to fit the report's grid to.
String value that represents a boolean value.
This value is read only if WebEventArgumentPDFScalingOption is set to SCALING_FIT_TO_PAGE_OPTION.
Used in following event:

Argument to specify how many pages wide to fit the report's grid to.
String value that represents a boolean value.
This value is read only if WebEventArgumentPDFScalingOption is set to SCALING_FIT_TO_PAGE_OPTION.
Used in following event:

Argument to specify the center section of the page's footer. Used in following event:

Argument to specify the left section of the page's footer. Used in following event:

Argument to specify the right section of the page's footer. Used in following event:

Argument to specify the center section of the page's header. Used in following event:

Argument to specify the left section of the page's header. Used in following event:

Argument to specify the right section of the page's header. Used in following event:

Argument to specify the paper's bottom margin. String value for representing an int value.
Used in following event:

Argument to specify the paper's left margin. String value for representing an int value.
Used in following event:

Argument to specify the paper's right margin. String value for representing an int value.
Used in following event:

Argument to specify the paper's top margin. String value for representing an int value.
Used in following event:

Argument to specify the maximum number of cells to export to PDF.
String value for representing an int value.
Used in following event:

Argument to specify the paper's footer maximum size.
String value for representing an int value.
Used in following event:

Argument to specify the paper's header maximum size.
String value for representing an int value.
Used in following event:

Argument to specify the Outline Mode state. Used in following event:

Argument to specify the paper orientation. The value for this parameter is String value corresponding to PAPER_ORIENTATION_PORTRAIT_OPTION or PAPER_ORIENTATION_PORTRAIT_OPTION.
Used in following event:

Argument to specify the paper size. The value of this parameter is a key from PaperSizes.xml.
Used in following event:

Argument to specify whether to scale the report's grid.
The value for this parameter is String value corresponding to SCALING_SHRINK_FONT_OPTION or SCALING_FIT_TO_PAGE_OPTION.
Used in following event:

Argument to specify whether to show the PDF options page before exporting.
String value that represents a boolean value.
Used in following event:

Argument to specify the percentage to shrink the grid to. String value for representing an int value.
This value is read only if WebEventArgumentPDFScalingOption is set to SCALING_SHRINK_FONT_OPTION.
Used in following event:

Argument to specify the port number where to open a connection to a Server.
This is String parameter whose value is the port number to used when opening a connection to a Server.
Used in the following events:

Argument to specify the group to use when 'Preferences' page is opened.
This String parameter is used for setting the event only if the feature for the group is enabled.
Used in following event:

Argument to specify the group set to use when 'Preferences' page is opened.
This String parameter is used for setting the event only if the feature for the group is enabled.
Used in following event:

Argument to specify transform name.
String parameter that represents a transform method to be used when going to 'Export' page.
Usage:

Argument to specify the path to the Administrator's footer file. Used in following event:

Argument to specify the path to the Administrator's header file. Used in following event:

Argument to specify whether to display a cover page with the filter details when printing. String value that represents a boolean value.
Used in following event:

Argument to specify the default number of columns per page. Used only for HTML mode. String value for representing an int value.
Used in following event:

Argument to specify the default number of rows per page. Used only for HTML mode. String value for representing an int value.
Used in following event:

Argument to specify whether to display the print popup window when printing. String value that represents a boolean value.
Used in following event:

Argument to specify whether to expand all page-by fields when printing a report that contains elements on the page-by axis. String value that represents a boolean value.
Used in following event:

Argument to specify whether to fit all grid's columns on one page.
String value that represents a boolean value.
This value is read only if WebEventArgumentPrintScalingOption is set to SCALING_FIT_TO_PAGE_OPTION.
Used in following event:

Argument to specify whether to fit all grid's rows on one page.
String value that represents a boolean value.
This value is read only if WebEventArgumentPrintScalingOption is set to SCALING_FIT_TO_PAGE_OPTION.
Used in following event:

Argument to specify the center section of the page's footer Used in following event:

Argument to specify the left section of the page's footer. Used in following event:

Argument to specify the right section of the page's footer. Used in following event:

Argument to specify the number of columns per page. Used only for HTML mode. String value for representing an int value.
Used in following event:

Argument to specify whether to display the grid and graph on the same page when printing a report in Grid and Graph mode. String value that represents a boolean value.
Used in following event:

Argument to specify the number of rows per page. Used only for HTML mode. String value for representing an int value.
Used in following event:

Argument to specify the center section of the page's header. Used in following event:

Argument to specify the left section of the page's header. Used in following event:

Argument to specify the right section of the page's header. Used in following event:

Argument to specify the paper's bottom margin. String value for representing an int value.
Used in following event:

Argument to specify the paper's left margin. String value for representing an int value.
Used in following event:

Argument to specify the paper's right margin. String value for representing an int value.
Used in following event:

Argument to specify the paper's top margin. String value for representing an int value.
Used in following event:

Argument to specify the maximum number of cells to print on a block of pages. String value for representing an int value.
Used in following event:

Argument to specify the maximum number of columns per page. Used only for HTML mode. String value for representing an int value.
Used in following event:

Argument to specify the paper's footer maximum size. String value for representing an int value.
Used in following event:

Argument to specify maximum number of graphs to print on a block of pages. String value for representing an int value.
Used in following event:

Argument to specify the paper's header maximum size. String value for representing an int value.
Used in following event:

Argument to specify the maximum number of rows per page. Used only for HTML mode. String value for representing an int value.
Used in following event:

Argument to specify whether to open a new browser window when printing. String value that represents a boolean value.
Used in following event:

Argument to specify the paper orientation.
The value for this parameter is String value corresponding to PAPER_ORIENTATION_PORTRAIT_OPTION or PAPER_ORIENTATION_PORTRAIT_OPTION.
Used in following event:

Argument to specify the paper size. The value of this parameter is a key from PaperSizes.xml.
Used in following event:

Argument to specify whether to scale the report's grid. The value for this parameter is String value corresponding to SCALING_SHRINK_FONT_OPTION or SCALING_FIT_TO_PAGE_OPTION.
Used in following event:

Argument to specify whether to show the print optins page before printing. String value that represents a boolean value.
Used in following event:

Argument to specify the percentage to shrink the grid to. String value for representing an int value.
This value is read only if WebEventArgumentPrintScalingOption is set to SCALING_SHRINK_FONT_OPTION.
Used in following event:

Argument to specify a Project name.
This is String parameter whose value is the name of the Project to access. It's used as parameter for setting up a connection to a Server
Used in the following events:

Argument to specify a name for a prompt style to be applied when transforming a Prompted report.
This argument will be used for setting ReportFrameBean property which will have higher precendece over existing formal parameters indicating which prompt style to use for specific Execution mode of given Report.

Indicate the type of querybuilder app to launch(multiple table, single source emma table, ffsql etc)

Argument to specify the Execution mode. Its value comes from EnumRWExecutionModes

Argument to specify the export mode. Used in following event:

Specifies the list of page by elements in the report writing document. These are separated by METRIC_ELEM_LIST_SEPARATOR. Used in the following events:

Argument to specify the relative page number of the page to display from the page history.
Used for the Back/Forward buttons.
Used in following event:

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:

Argument to specify a Filter ID when a Report is being edited.
This argument is a String representation of a Filter ID and it's used as argument in following event:

Argument to specify a Parent Folder ID of the executed Report.
Normally used as String parameter for setting a different parent folder Id to default. Argument used in following event:

Argument to specify the State ID of the executed Report.
This argument is a String representation of a State ID and it's used as argument in following event:

Argument to specify a Template ID when a Report is being edited.
This argument is a String representation of a Template ID and it's used as argument in following event:

Argument to determine report's view mode.
Event parameter (String value) to see the report either as a grid or a graph on execution mode.
Normally, it's set by calling function setArgumentValue.
Used in following event:

Argument to indicate the orgin of the save as action.
String representation for an int value that specified where the SaveAs event comes from. It's used in following event:

Argument to indicate the origin bean path in previous page. If save as is canceled, this bean path can be used to find original bean and invoke events on it.

Argument to specify if we need to show the continue button on the save as confirmation page after a save action. It's used in following event:

Argument to enabling edit mode when scheduling a Report.
String parameter to represent an int value.
Used in following event:

Argument to specify a search pattern in quick search events.
Search string, used in the following event:

Argument to specify Server alias.
This is String parameter whose value is the alias of the Server to connect. It's used as parameter for setting up a connection to a Server
Used in the following events:

Argument to specify Server name.
This is String parameter whose value is the name of the Server to connect. It's used as parameter for setting up a connection to a Server
Used in the following events:

Argument to specify Session key to look for while preparing the Session Manager with the current session.
String argument to represent a Session key value.
Used by following event:

Used in following event:

Used in following event:

Whether to show the export options page when exporting.
Note: Used for customizations only.
Used in following event:

Used in following event:

Argument to specify Sub page name for WebEventOpenHelp event.
String argument that represents the name of the sub page to be opened by the WebEventOpenHelp event.
Used in following event:

Argument to specify the delivery mode (email/fle/print) for a NCS subscription. String parameter that represents the delivey mode.
It's used in following event:

Argument to specify a subscription ID when requesting a report writing document to be exported from the subscriptions page. String parameter that represents an Id for a subscription.
It's used in following event:

Argument to specify a target parameter for pages that will require a redirect.
This argument is consisted of a String value. It mostly used to represent target page name where to redirect to. Normally, it's set by calling function setArgumentValue.
It is a parameter for the following events:

Specifies the content tree type to which the grid object belongs to for filter on selections from doc to report Used in following event:

Argument to specify a trigger ID when editing a subscription.
String parameter that represents an Id for a trigger.
It's used in following event:

Argument for the two step verification code used during login.

Argument to specify whether to render JavaScript code to update the window's parent (ie report page) with the latest bean state.
Used to save the PDF/print report properties.
This will be typically set to true if the coming from the report page.
Used in following event:

Argument to specify the login ID, which is part of the user credentials.
String parameter passed to login event.
Used by following event:

Argument to specify the User Id for changin his/her password.
String argument that represents end user's name to be used when creating WebEventCallChangePassword event that will be used for allowing the user to change the password if it is required before showing the project list corresponding to an I-Server.
Used in following event:

Argument to specify the password which is part of the user credentials.
String parameter passed to login event.
Used by following event:

Argument to specify whether to export the filter details.
Used in following event:

Event for changing user's password.

Event for cancelling a given event.
If there's still a null event, then cancel event is invoked for getting rid of it.

Event for closing dashboard page

Event to create a blank VI. Mode (HTML5/Flash) is auto-detected.

Event to handle creating New Analysis Document in HTML5 VI page.

Event for creating a user.

Event for creating a user group.

Event for clearing history list.

Event for deleting an object.

Event for filter on selections from a document to a report.

Event to edit a cache subscription

Event to edit a history list subscription

Event to edit a mobile subscription

Event for exporting RWD PDF data back to the client.

Event for editing a report.

Event for editing a security role.

Event to open a page for editing a subscription.

Event for editing a user.

Event for editing a user group.

Event to add a mobile subscription

Event for opening the ExportSaveReportProperties page.

Event for executing a document (with prompts, if applicable) before performing an export to it.

Event for executing an export without having to run the report first.

Event for executing a PDF export for an not executed Report.

Event for forwarding to RW fast export.
We need to change the URL before geting there.

Generic event, which will not cause any process to be executed if called.

Event for getting the document details.

Event for getting the report writing document details.

Event for getting the report details.

Event for graph drilling from a document to a report.

Event for grid drilling from a document to a report.

Event for handling menu selections when HTML mode is on.

Event to handle opening a HTML5 VI subscription.

Event for loading Report's Graph.
Normally, this graph is in GIF format.

Event for logging out the application.

Event to open the page of Narrowcast Server FTP addresses.

Event to open the page of Narrowcast Server print addresses.

Event to open the page of Narrowcast Server print addresses.

Event to open a page for adding a Narrowcast Server subscription.

Event to open the page of Narrowcast Server email addresses.

Event to open the page of Narrowcast Server FTP addresses.

Event to open the page of Narrowcast Server print addresses.

Event to open the page of Narrowcast Server print addresses.

Event to open a page for editing a Narrowcast Server subscription.

Event to open the page of Narrowcast Server FTP addresses.

Event to open the page of Narrowcast Server file addresses.

Event for opening the 'Delete an address' page.

Event to open the page of Narrowcast Server print addresses.

Event to open a page for sending an object through email.
The application needs to support this event, otherwise, a null value will be set to this event.

Event for showing confirmation page for NCS send now subscriptions.

Event for showing confirmation page for NCS email, file opr print subscriptions.

Event for opening 'About' page.

Event for opening the Administrator frequently asked questions page.

Event for opening the Administrator online help page.

Event for opening the Administrator online help index.

Event for opening Application Schema page

Event for opening 'Create Reports' folder.

Event for opening 'Create Document' page.

Event for opening the 'Default Desktop' page.

Event to force open default home page independent of user preference.

Event for opening 'Desktop' page.

Event for opening the 'Diagnostics configuration' page.

Event for opening 'Export' page.

Event for opening the 'Export document' page.

Event for opening the 'Export options' page.

Event for opening the export options page

Event for opening 'FAQs' page.

Event for opening 'Help' page.

Event for opening 'Help Index' page.

Event for opening 'Help setup' page.

Event for opening the 'History list' page.

Event for opening a page from the page history

Event for opening home page of MSTR web application.
Default event for the servlet.

This is for the IPA servlet event handling

Opens the Import Wizard.
Will redirect to an Analysis if provided as {WebEventArgumentAnalysisID}. When this happens the imported cube whould be added to the Analysis before executing

Open DataImport entry page

Event for opening 'My Reports' page.

Event for opening the 'My Subscriptions' page.

Event for opening the 'My subscriptions' page.
All the susbcriptions for an object rather than to a page.

Event for opening the MicroStrategy Office Setup page.

Event for opening the 'PDF options' page.

Event for opening the 'PDF options' page from an active Report page.

Event to save the PDF properties.
Called right before exporting to PDF to save the PDF web properties on the Report Instance.

Event for opening any page in application.
The name of the page is part of the argument's list.

Event for opening the 'Preferences' page.

Event for opening the 'Print' page.

Event for opening the 'Print document' page.

Event for opening the 'Print options' page.

Event for opening the 'Printing oprions' page from an active Report page.

Event to save printing properties.
Called right before print to save the print web properties on the Report Instance.

This is for query builder servlet event

Reserved for future use.

Reserved for future use.

Reserved for future use.

Event for opnening the Save Report Properties page used in Export, PDF and Print.

Event to Open Schedule page.

Event to open the 'Search' page.

Event for opening 'Security setup' page.

Event for opening 'Shared Reports' page.

Event for opening 'Subscriptions Engine setup' page.

Event for opening the 'Summary' page.

Event for opening the top level user groups.

Event for opening 'Wizard' page.

Event for exporting PDF data back to the client.

Event to open the page to edit color palettes

Event to open the page of Dynamic addresse list in preference setting.

Event to indicate that a login process will be performed.
After it, the page where to go will be specified on the target argument of this event.

Event for performing a quick logout.

Event for opnening the Save Report Properties page used in Export, PDF and Print.

Event for exporting RWD data back to the client.

Event for opening report writer 'Save as' page.

Export report to Flash

Event for exporting a report writing document to PDF. This event shall be used after WebEventReportWritingDocumentPDFFastExport has been executed.

Event for triggering the fast export of report writing documents. Wait page and prompts will be handled here.

Event for opening the last page mark as visited.
If no page has been saved as previous visited, then it returns to the default page.

Event for performing any search.

Event for opening 'Save as' page.

Event to select a filter for template/filter execution.

Event to select a template for template/filter execution.

Event for opening 'Desktop' page.

Reserved for future use.

Opens an Analysis object.
Allows a Dataset to be added before executing it

Open preference change password page