Supported Bean: ServletWebComponent

This class implements the WebComponent interface for having its methods available to the application Servlet.

Event handler: com.microstrategy.web.app.beans.EnumSysBeanTypes.AppBeanServlet (3)

Application bean type for the Servlet component

Events

addSubscription, browseFolder, browseUserGroup, cancel, close, colorPalette, createHTML5VI, createPrompt, createSecRole, createUser, createUserGroup, dashboardPublishWizard , delete, deleteHistoryList, displayError, drillToFixedTemplateFromDocumentToReport, editPrompt, editReport, editRW, editSecRole, editSubscription, editUser, editUserGroup, executeHTML5VI, executeIVE, executeRWDocumentHeavy, executeRWDocumentLight, fastDocumentExport, fastExport, fastPDFExport, forwardToRWExport, generic, getChangePwd, getDocumentDetails, getReportDetails, graphDrillFromDocumentToReport, gridDrillFromDocumentToReport, htmlMenu, inbox, initializeFromSchedule, initializeFromSchedule, initializeFromSchedule, initializeFromSubscription, initializeFromSubscription, initializeFromSubscription, initializeHTML5VIFromSubscription, loadGraph, logout, ncAddCacheSubscription, ncAddFileSubscription, ncAddFTPSubscription, ncAddInboxSubscription, ncAddMobileSubscription, ncAddPersonalViewSubscription, ncAddPrintSubscription, ncAddresses, ncAddSubscription, ncEditCacheSubscription, ncEditFileSubscription, ncEditFTPSubscription, ncEditInboxSubscription, ncEditMobileSubscription, ncEditPersonalViewSubscription, ncEditPrintSubscription, ncEditSubscription, ncFileAddresses, ncFTPAddresses, ncPrintAddresses, ncSendNow, ncSendNowConfirm, ncSubsConfirm, open, openAbout, openAdminFAQs, openAdminHelp, openAdminHelpIndex, openAdminHome, openAdminHome, openAnalysis, openAppSchemaPage, openCreate, openCreateDocument, openCreatePrompt, openDefaultDesktop, openDefaultHome, openDeleteAddress, openDesktop, openDesktop, openDiagnostics, openDRL, openExport, openExportDocument, openExportOptions, openExportOptionsFromReport, openExportSaveReportProperties, openFAQs, openFilterEditor, openHelp, openHelpIndex, openHelpSetup, openHistoryPage, openHome, openHomeCards, openImportEntryPage, openImportWizard, openIPAEnvironmentDetails, openMy, openMySubscriptions, openObjectSubscriptions, openOfficeSetup, openPDFOptions, openPDFOptionsFromReport, openPrefChPwd, openPreferences, openPrint, openPrintDocument, openPrintOptions, openPrintOptionsFromReport, openPublicDashbord, openPublicShare, openRRAcceptanceForm, openRRAccountSettings, openRRUserImport, openRRUserManagement, openRWSaveAs, openSaveAs, OpenSaveReportProperties, openSearch, openSecuritySetup, openShared, openSubscriptionEngineSetup, openSummary, openTopLevelUserGroups, openWizard, pdfDisplay, quickLogout, reportFlashExport, returnTo, runDocument, runReport, runReport, runTemplateFilter, rwDetails, rwdHTMLExport, rwExport, rwFastPDFExport, rwPDFExport, savePassword, schedule, search, selectFilter, selectTemplate, showSecRoles, WebArchitectEntryPage

addSubscription
Event to open a page for adding a subscription.

3034

EnumServletEvents.WebEventAddSubscription

editMode

Argument to enabling edit mode when scheduling a Report.
String parameter to represent an int value.
Used in following event:
  • EnumServletEvents.WebEventEditSubscription
    Normally, '1' is used for enabling edit mode.
  • 3035

    EnumServletEvents.WebEventArgumentScheduleEditMode

    elementsPromptAnswers

    Plain element prompt answer.

    5120012

    EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

    messageID

    Argument specifying the message ID.

    512001

    EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_MESSAGE_ID

    mobile

    5120016

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_MOBILE

    objectID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    objectType

    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:
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • 3007

    EnumServletEvents.WebEventArgumentObjectType

    originMessageID

    Origin message ID.

    5120010

    EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

    overwrite

    Argument specifying whether or not to overwrite an existing schedule that was created with the same content and trigger.

    512006

    EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_OVERWRITE_EXISTING

    promptsAnswerXML

    Origin short answer XML.

    5120011

    EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

    reuse

    Indicates whether the messageID should be reused or new messages should be created with each execution.

    512008

    EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_REUSE_MESSAGE

    stateID

    Argument specifying the state ID.

    512002

    EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_STATE_ID

    triggerID

    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:
  • EnumServletEvents.WebEventEditSubscription
  • 3029

    EnumServletEvents.WebEventArgumentTriggerID

    viewMode

    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:
  • EnumServletEvents.WebEventEditReport
    The value for this parameter is specified in EnumWebReportViewMode
  • 3005

    EnumServletEvents.WebEventArgumentReportViewMode

    browseFolder
    event for browsing a given folder.

    2001

    EnumFolderBeanEvents.FOLDER_EVENT_BROWSE

    folderID

    objectID -- argument using for browsing objects.

    1001

    EnumObjectBeanEvents.OBJECT_EVENT_ARGUMENT_OBJECT_ID

    folderName

    objectName

    1004

    EnumObjectBeanEvents.OBJECT_EVENT_ARGUMENT_OBJECT_NAME

    systemFolder

    Specifies the system folder to browse into.

    2023

    EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_SYS_FOLDER

    browseUserGroup
    event for browsing a given object.

    1001

    EnumObjectBeanEvents.OBJECT_EVENT_BROWSE

    *groupID

    objectID -- argument using for browsing objects.

    1001

    EnumObjectBeanEvents.OBJECT_EVENT_ARGUMENT_OBJECT_ID

    objectFlag

    flags -- integer argument specifying the flags (from EnumDSSXMLObjectFlags ) to be used while performing object browse operations.

    1003

    EnumObjectBeanEvents.OBJECT_EVENT_ARGUMENT_FlAGS

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

    3026

    EnumServletEvents.WebEventCancel

    close
    Event for closing dashboard page

    3198

    EnumServletEvents.WebEventCloseDashboardPage

    colorPalette
    Event to open the page to edit color palettes

    3188

    EnumServletEvents.WebEventPrefColorPalette

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

    3185

    EnumServletEvents.WebEventCreateHTML5VI

    executionMode

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

    3115

    EnumServletEvents.WebEventArgumentRWExecutionMode

    messageID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • 3010

    EnumServletEvents.WebEventArgumentMessageID

    objectID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    objectType

    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:
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • 3007

    EnumServletEvents.WebEventArgumentObjectType

    parentFolderId

    3185

    EnumServletEvents.WebEventArgumentParentFolderId

    rwCreateFlags

    3163

    EnumServletEvents.WebEventArgumentRWCreationFlags

    createPrompt

    3118

    EnumServletEvents.WebEventCreatePrompt

    folderId

    3135

    EnumServletEvents.WebEventArgumentFolderId

    promptExpressionType

    3139

    EnumServletEvents.WebEventArgumentPromptExpressionType

    promptType

    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:
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • 3007

    EnumServletEvents.WebEventArgumentObjectType

    createSecRole

    3122

    EnumServletEvents.WebEventCreateSecurityRole

    createUser
    Event for creating a user.

    3116

    EnumServletEvents.WebEventCreateUser

    parentId

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    createUserGroup
    Event for creating a user group.

    3117

    EnumServletEvents.WebEventCreateUserGroup

    userId

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    dashboardPublishWizard

    3138

    EnumServletEvents.WebEventDashboardPublishWizard

    delete
    Event for deleting an object.

    3015

    EnumServletEvents.WebEventDeleteObject

    objectID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    objectType

    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:
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • 3007

    EnumServletEvents.WebEventArgumentObjectType

    target

    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:
  • EnumServletEvents.WebEventOpenPage
  • EnumServletEvents.WebEventLogout
  • EnumServletEvents.WebEventReturnTo
  • EnumServletEvents.WebEventProcessLogin
  • 3004

    EnumServletEvents.WebEventArgumentTarget

    deleteHistoryList
    Event for clearing history list.

    3024

    EnumServletEvents.WebEventDeleteHistoryList

    displayError

    3193

    EnumServletEvents.WebEventDisplayError

    message

    3184

    EnumServletEvents.WebEventArgumentMessage

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

    3127

    EnumServletEvents.WebEventDrillToFixedTemplateFromDocToReport

    displayMode

    Specifies the display mode. A value from the enumeration EnumDSSXMLDisplayMode Used in following event:
  • EnumServletEvents.WebEventGraphDrillFromDocToReport
  • 3146

    EnumServletEvents.WebEventArgumentDrillDisplayMode

    nodeKey

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

    EnumServletEvents.WebEventArgumentNodeKey

    rwGroupByElements

    Specifies the list of page by elements in the report writing document. These are separated by EnumReportBeanEvents.METRIC_ELEM_LIST_SEPARATOR. Used in the following events:
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • EnumServletEvents.WebEventGraphDrillFromDocToReport
  • EnumServletEvents.WebEventDrillToFixedTemplateFromDocToReport
    When drilling from a report writing document to a grid outside the document, the page by elements are required to set the current element on the page by of the resulting grid.
  • 3151

    EnumServletEvents.WebEventArgumentRWPageByElements

    rwMesageID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • 3010

    EnumServletEvents.WebEventArgumentMessageID

    sliceId

    3152

    EnumServletEvents.WebEventArgumentSliceId

    treeType

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

    EnumServletEvents.WebEventArgumentTreeType

    editPrompt

    3119

    EnumServletEvents.WebEventEditPrompt

    objectID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    promptType

    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:
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • 3007

    EnumServletEvents.WebEventArgumentObjectType

    editReport
    Event for editing a report.

    3005

    EnumServletEvents.WebEventEditReport

    cubeID

    3136

    EnumServletEvents.WebEventArgumentCubeReportId

    messageID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • 3010

    EnumServletEvents.WebEventArgumentMessageID

    promptStyle

    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.

    30051

    EnumServletEvents.WebEventArgumentPromptStyle

    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

    reportID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    reportViewMode

    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:
  • EnumServletEvents.WebEventEditReport
    The value for this parameter is specified in EnumWebReportViewMode
  • 3005

    EnumServletEvents.WebEventArgumentReportViewMode

    srcID

    3155

    EnumServletEvents.WebEventArgumentSourceId

    srcType

    3138

    EnumServletEvents.WebEventArgumentSourceType

    editRW
    Event for exporting RWD PDF data back to the client.

    3104

    EnumServletEvents.WebEventEditRW

    convertFromVI

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

    3182

    EnumServletEvents.WebEventArgumentConvertDashboardToDoc

    executionMode

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

    3115

    EnumServletEvents.WebEventArgumentRWExecutionMode

    importAfterSave

    3177

    EnumServletEvents.RWebEventArgumentIMPORTAFTERSAVE

    messageID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • 3010

    EnumServletEvents.WebEventArgumentMessageID

    objectID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    objectType

    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:
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • 3007

    EnumServletEvents.WebEventArgumentObjectType

    rptStateID

    2048143

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_REGENERATE

    rwCreateFlags

    3163

    EnumServletEvents.WebEventArgumentRWCreationFlags

    rwCreateTemplateID

    3164

    EnumServletEvents.WebEventArgumentRWCreationTemplateID

    rwDesignMode

    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

    rwViewMode

    3158

    EnumServletEvents.WebEventArgumentRWViewMode

    editSecRole
    Event for editing a security role.

    3121

    EnumServletEvents.WebEventEditSecurityRole

    sRoleId

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    editSubscription
    Event to open a page for editing a subscription.

    3033

    EnumServletEvents.WebEventEditSubscription

    editMode

    Argument to enabling edit mode when scheduling a Report.
    String parameter to represent an int value.
    Used in following event:
  • EnumServletEvents.WebEventEditSubscription
    Normally, '1' is used for enabling edit mode.
  • 3035

    EnumServletEvents.WebEventArgumentScheduleEditMode

    elementsPromptAnswers

    Plain element prompt answer.

    5120012

    EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

    messageID

    Argument specifying the message ID.

    512001

    EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_MESSAGE_ID

    objectID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    objectType

    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:
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • 3007

    EnumServletEvents.WebEventArgumentObjectType

    originMessageID

    Origin message ID.

    5120010

    EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

    overwrite

    Argument specifying whether or not to overwrite an existing schedule that was created with the same content and trigger.

    512006

    EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_OVERWRITE_EXISTING

    promptsAnswerXML

    Origin short answer XML.

    5120011

    EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

    reuse

    Indicates whether the messageID should be reused or new messages should be created with each execution.

    512008

    EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_REUSE_MESSAGE

    stateID

    Argument specifying the state ID.

    512002

    EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_STATE_ID

    triggerID

    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:
  • EnumServletEvents.WebEventEditSubscription
  • 3029

    EnumServletEvents.WebEventArgumentTriggerID

    viewMode

    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:
  • EnumServletEvents.WebEventEditReport
    The value for this parameter is specified in EnumWebReportViewMode
  • 3005

    EnumServletEvents.WebEventArgumentReportViewMode

    editUser
    Event for editing a user.

    3114

    EnumServletEvents.WebEventEditUser

    userId

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    editUserGroup
    Event for editing a user group.

    3115

    EnumServletEvents.WebEventEditUserGroup

    groupId

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    executeHTML5VI

    3140

    EnumServletEvents.WebEventExecuteHTML5VI

    currentViewMedia

    Media type

    2048174

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_MEDIA_TYPE

    documentID

    Object ID.

    2048001

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_OBJECT_ID

    documentName

    Object name.

    2048020

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_OBJECT_NAME

    elementsPromptAnswers

    Specifies element prompts' answers in a URL friendly format.

    2048089

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

    execFlags

    Execution flags

    2048003

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXEC_FLAGS

    executionMode

    Execution mode (see EnumRWExecutionModes).

    2048092

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXECUTION_MODE

    freshExec

    Argument indicating whether the RW document to be executed with fresh-execution related execution flags.

    2048060

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_REEXECUTE_FRESH

    layoutIndex

    Argument used to select the layout by index, base 0, to be shown when a dashboard or document is executed

    2048300

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_LAYOUT_INDEX

    layoutKey

    Argument used to select the layout by key to be shown when a dashboard or document is executed

    2048299

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_LAYOUT_KEY

    linkAnswers

    2048140

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_LINK_ANSWERS

    maxWait

    Max time in milliseconds to wait for event execution. A value of -1 means wait indefinitely.

    2048093

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_MAX_WAIT

    messageID

    Message ID.

    2048002

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_MESSAGE_ID

    objectsPromptAnswers

    Specifies an argument for the new prompt answer for WebObjectsPrompt in document drilling.

    2048133

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PLAIN_OBJECT_PROMPT_ANSWER

    objType

    Object type (see EnumDSSXMLObjectTypes).

    2048009

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_OBJECT_TYPE

    originMessageID

    Specifies the message ID of the original Document (HTML or RW) whose prompt answers are going to be retrieved.

    2048087

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

    pollingFreq

    Polling frequency.

    2048094

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_POLLING_FREQUENCY

    promptAnswerMode

    An integer prompt answer mode from EnumWebPromptAnswerMode

    2048201

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PROMPT_ANSWER_MODE_OPTION

    promptsAnswerXML

    Specifies the prompt answer XML from the original Document (HTML or RW).

    2048088

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

    resolveOnly

    Argument used to indicate whether use execution resolveOnly flag

    2048309

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_RESOLVE_ONLY

    rptStateID

    Control source object ID

    2048114

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_SOURCE_ID

    rptViewMode

    integer argument of EnumWebReportViewMode specifying the report view mode.

    4115

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_VIEW_MODE

    selectorMode

    Indicates whether to copy the selector's selections when link drilling from one document to another.
    Depends on {EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID being passed. The options are:
    - 0 - Do not pass selector values
    - 1 - Pass selector values - match selectors by ID
    - 2 - Pass selector values - match selectors by name

    2048261

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SELECTOR_MODE

    srcAnswers

    2048215

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SRC_ANSWERS

    useDefAns

    Whether to use default prompt answers.

    2048103

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_USE_DEFAULT_PROMPT_ANSWERS

    valuePromptAnswers

    Specifies an argument for the new prompt answer for WebConstantPrompt in document drilling.

    2048132

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER

    visMode

    Visualization mode.

    2048109

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_VISUALIZATION_MODE

    executeIVE

    3139

    EnumServletEvents.WebEventExecuteMojoIVE

    currentViewMedia

    Media type

    2048174

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_MEDIA_TYPE

    documentID

    Object ID.

    2048001

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_OBJECT_ID

    documentName

    Object name.

    2048020

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_OBJECT_NAME

    elementsPromptAnswers

    Specifies element prompts' answers in a URL friendly format.

    2048089

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

    execFlags

    Execution flags

    2048003

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXEC_FLAGS

    executionMode

    Execution mode (see EnumRWExecutionModes).

    2048092

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXECUTION_MODE

    freshExec

    Argument indicating whether the RW document to be executed with fresh-execution related execution flags.

    2048060

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_REEXECUTE_FRESH

    linkAnswers

    2048140

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_LINK_ANSWERS

    maxWait

    Max time in milliseconds to wait for event execution. A value of -1 means wait indefinitely.

    2048093

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_MAX_WAIT

    messageID

    Message ID.

    2048002

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_MESSAGE_ID

    objType

    Object type (see EnumDSSXMLObjectTypes).

    2048009

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_OBJECT_TYPE

    originMessageID

    Specifies the message ID of the original Document (HTML or RW) whose prompt answers are going to be retrieved.

    2048087

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

    pollingFreq

    Polling frequency.

    2048094

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_POLLING_FREQUENCY

    promptAnswerMode

    An integer prompt answer mode from EnumWebPromptAnswerMode

    2048201

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PROMPT_ANSWER_MODE_OPTION

    promptsAnswerXML

    Specifies the prompt answer XML from the original Document (HTML or RW).

    2048088

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

    rptStateID

    Control source object ID

    2048114

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_SOURCE_ID

    rptViewMode

    integer argument of EnumWebReportViewMode specifying the report view mode.

    4115

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_VIEW_MODE

    showFiltersPanel

    2049999

    useDefAns

    Whether to use default prompt answers.

    2048103

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_USE_DEFAULT_PROMPT_ANSWERS

    valuePromptAnswers

    Specifies an argument for the new prompt answer for WebConstantPrompt in document drilling.

    2048132

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER

    visMode

    Visualization mode.

    2048109

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_VISUALIZATION_MODE

    executeRWDocumentHeavy
    Event to add a mobile subscription

    3135

    EnumServletEvents.WebEventExecuteRWDocumentHeavy

    currentViewMedia

    Media type

    2048174

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_MEDIA_TYPE

    documentID

    Object ID.

    2048001

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_OBJECT_ID

    documentName

    Object name.

    2048020

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_OBJECT_NAME

    elementsPromptAnswers

    Specifies element prompts' answers in a URL friendly format.

    2048089

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

    execFlags

    Execution flags

    2048003

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXEC_FLAGS

    executionMode

    Execution mode (see EnumRWExecutionModes).

    2048092

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXECUTION_MODE

    freshExec

    Argument indicating whether the RW document to be executed with fresh-execution related execution flags.

    2048060

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_REEXECUTE_FRESH

    importAfterSave

    3177

    EnumServletEvents.RWebEventArgumentIMPORTAFTERSAVE

    linkAnswers

    2048140

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_LINK_ANSWERS

    maxWait

    Max time in milliseconds to wait for event execution. A value of -1 means wait indefinitely.

    2048093

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_MAX_WAIT

    messageID

    Message ID.

    2048002

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_MESSAGE_ID

    objType

    Object type (see EnumDSSXMLObjectTypes).

    2048009

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_OBJECT_TYPE

    originMessageID

    Specifies the message ID of the original Document (HTML or RW) whose prompt answers are going to be retrieved.

    2048087

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

    pollingFreq

    Polling frequency.

    2048094

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_POLLING_FREQUENCY

    promptAnswerMode

    An integer prompt answer mode from EnumWebPromptAnswerMode

    2048201

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PROMPT_ANSWER_MODE_OPTION

    promptsAnswerXML

    Specifies the prompt answer XML from the original Document (HTML or RW).

    2048088

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

    rptStateID

    Control source object ID

    2048114

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_SOURCE_ID

    rptViewMode

    integer argument of EnumWebReportViewMode specifying the report view mode.

    4115

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_VIEW_MODE

    useDefAns

    Whether to use default prompt answers.

    2048103

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_USE_DEFAULT_PROMPT_ANSWERS

    valuePromptAnswers

    Specifies an argument for the new prompt answer for WebConstantPrompt in document drilling.

    2048132

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER

    visMode

    Visualization mode.

    2048109

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_VISUALIZATION_MODE

    executeRWDocumentLight
    Event to execute a Report Writing document. Note that settings the maxWait value indirectly controls the async parameter If the value of maxWait is set to 0, it is considered asynchronous execution WebResultSetInstance.setAsync(boolean).

    This method is also used for converting reports into report writing documents. There are two ways to perform this conversion:

    1. Report ID. The report ID is specified in the object ID field.
    2. Message ID and State ID. The message ID, and state ID (optional) of the report is specified. This requires object type of EnumDSSXMLObjectTypes.DssXmlTypeReportDefinition to be explicitly declared. The template display mode governing grid and graph display may also be specified.

    2048001

    EnumRWBeanEvents.REPORT_WRITER_EVENT_EXECUTE

    backgroundExec

    Argument indicating whether the RW document to be executed as a background job.

    2048242

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXECUTE_BACKGROUND

    creationFlags

    Flags governing report to document creation. See EnumDSSXMLRWEaseCreationFlags.

    2048209

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CREATION_FLAGS

    currentViewMedia

    Media type

    2048174

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_MEDIA_TYPE

    deltaXml

    An string present the manipulator deltaXml

    2048202

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DELTAXML

    documentID

    Object ID.

    2048001

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_OBJECT_ID

    documentName

    Object name.

    2048020

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_OBJECT_NAME

    doNotUpdateCaches

    2048257

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_DO_NOT_UPDATE_CACHES

    elementsPromptAnswers

    Specifies element prompts' answers in a URL friendly format.

    2048089

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

    execFlags

    Execution flags

    2048003

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXEC_FLAGS

    executionMode

    Execution mode (see EnumRWExecutionModes).

    2048092

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXECUTION_MODE

    freshExec

    Argument indicating whether the RW document to be executed with fresh-execution related execution flags.

    2048060

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_REEXECUTE_FRESH

    importAfterSave

    3177

    EnumServletEvents.RWebEventArgumentIMPORTAFTERSAVE

    linkAnswers

    2048140

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_LINK_ANSWERS

    maxWait

    Max time in milliseconds to wait for event execution. A value of -1 means wait indefinitely.

    2048093

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_MAX_WAIT

    messageID

    Message ID.

    2048002

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_MESSAGE_ID

    objectsPromptAnswers

    Specifies an argument for the new prompt answer for WebObjectsPrompt in document drilling.

    2048133

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PLAIN_OBJECT_PROMPT_ANSWER

    objType

    Object type (see EnumDSSXMLObjectTypes).

    2048009

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_OBJECT_TYPE

    originMessageID

    Specifies the message ID of the original Document (HTML or RW) whose prompt answers are going to be retrieved.

    2048087

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

    pollingFreq

    Polling frequency.

    2048094

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_POLLING_FREQUENCY

    prevMsgID

    2048256

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PREVIOUS_MESSAGE_ID

    promptAnswerMode

    An integer prompt answer mode from EnumWebPromptAnswerMode

    2048201

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PROMPT_ANSWER_MODE_OPTION

    promptsAnswerXML

    Specifies the prompt answer XML from the original Document (HTML or RW).

    2048088

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

    resolveOnly

    Argument used to indicate whether use execution resolveOnly flag

    2048309

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_RESOLVE_ONLY

    rptStateID

    Control source object ID

    2048114

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_SOURCE_ID

    rptStateID

    2048143

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_REGENERATE

    rptViewMode

    View mode (see EnumWebReportViewMode).

    4115

    EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_VIEW_MODE

    selectorMode

    Indicates whether to copy the selector's selections when link drilling from one document to another.
    Depends on {EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID being passed. The options are:
    - 0 - Do not pass selector values
    - 1 - Pass selector values - match selectors by ID
    - 2 - Pass selector values - match selectors by name

    2048261

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SELECTOR_MODE

    srcAnswers

    2048215

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SRC_ANSWERS

    templateID

    Optional template ID for report to document creation

    2048210

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CREATION_TEMPLATE_ID

    useDefAns

    Whether to use default prompt answers.

    2048103

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_USE_DEFAULT_PROMPT_ANSWERS

    valuePromptAnswers

    Specifies an argument for the new prompt answer for WebConstantPrompt in document drilling.

    2048132

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER

    visMode

    Visualization mode.

    2048109

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_VISUALIZATION_MODE

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

    3063

    EnumServletEvents.WebEventFastDocumentExport

    documentID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    documentName

    objectName

    1004

    EnumObjectBeanEvents.OBJECT_EVENT_ARGUMENT_OBJECT_NAME

    elementsPromptAnswers

    Specifies an argument for the new prompt answer for WebElementsPrompt in document drilling.

    32339

    EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

    executionFlags

    Specifies an argument for the object id of a Document.

    32201

    EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_EXECUTION_FLAGS

    messageID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • 3010

    EnumServletEvents.WebEventArgumentMessageID

    originMessageID

    Specifies an argument for the original document message id in document drilling.

    32337

    EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

    promptsAnswerXML

    Specifies an argument for the original document's prompt answer XML in document drilling.

    32338

    EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

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

    3067

    EnumServletEvents.WebEventFastExport

    defaultRunMode

    3157

    EnumServletEvents.WebEventArgumentExportDefaultRunMode

    dispFlags

    SaveAs display flags.

    4004

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DISPLAY_FLAGS

    duplicateMessage

    Specifies whether to duplicate the message passed.

    4171

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_EXECUTION_DUPLICATE_MESSAGE_ID

    elementsPromptAnswers

    Specifies an argument for the new prompt answer for WebElementsPrompt in document drilling.

    4189

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

    execFlags

    flags to be used while performing report execution.

    4002

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_EXECUTION_FLAGS

    graphHeigth

    height of the graph.

    4080

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_HEIGHT

    graphWidth

    width of the graph.

    4081

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_WIDTH

    messageID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • 3010

    EnumServletEvents.WebEventArgumentMessageID

    originMessageID

    Specifies an argument for the original report message id in document drilling.

    4187

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

    promptAnswerMode

    An integer prompt answer mode from EnumWebPromptAnswerMode

    4232

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_PROMPT_ANSWER_MODE_OPTION

    promptsAnswerXML

    Specifies an argument for the original report's prompt answer XML in document drilling.

    4188

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

    reportID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    reportName

    objectName

    1004

    EnumObjectBeanEvents.OBJECT_EVENT_ARGUMENT_OBJECT_NAME

    reportViewMode

    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:
  • EnumServletEvents.WebEventEditReport
    The value for this parameter is specified in EnumWebReportViewMode
  • 3005

    EnumServletEvents.WebEventArgumentReportViewMode

    resultFlags

    result flags.

    4003

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_RESULT_FLAGS

    saveFlags

    save as flags.

    4005

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SAVE_AS_FLAGS

    showOptionsPage

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

    EnumServletEvents.WebEventArgumentShowOptionsPage

    stateID

    state ID of the report.

    4118

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_EXECUTION_STATE_ID

    valuePromptAnswers

    Specifies an argument for the new prompt answer for WebConstantPrompt in document drilling.

    4220

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER

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

    3062

    EnumServletEvents.WebEventFastPDFExport

    dispFlags

    SaveAs display flags.

    4004

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DISPLAY_FLAGS

    duplicateMessage

    Specifies whether to duplicate the message passed.

    4171

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_EXECUTION_DUPLICATE_MESSAGE_ID

    elementsPromptAnswers

    Specifies an argument for the new prompt answer for WebElementsPrompt in document drilling.

    4189

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

    execFlags

    flags to be used while performing report execution.

    4002

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_EXECUTION_FLAGS

    graphHeigth

    height of the graph.

    4080

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_HEIGHT

    graphWidth

    width of the graph.

    4081

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_WIDTH

    messageID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • 3010

    EnumServletEvents.WebEventArgumentMessageID

    originMessageID

    Specifies an argument for the original report message id in document drilling.

    4187

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

    promptAnswerMode

    An integer prompt answer mode from EnumWebPromptAnswerMode

    4232

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_PROMPT_ANSWER_MODE_OPTION

    promptsAnswerXML

    Specifies an argument for the original report's prompt answer XML in document drilling.

    4188

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

    reportID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    reportName

    objectName

    1004

    EnumObjectBeanEvents.OBJECT_EVENT_ARGUMENT_OBJECT_NAME

    reportViewMode

    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:
  • EnumServletEvents.WebEventEditReport
    The value for this parameter is specified in EnumWebReportViewMode
  • 3005

    EnumServletEvents.WebEventArgumentReportViewMode

    resultFlags

    result flags.

    4003

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_RESULT_FLAGS

    saveFlags

    save as flags.

    4005

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SAVE_AS_FLAGS

    stateID

    state ID of the report.

    4118

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_EXECUTION_STATE_ID

    valuePromptAnswers

    Specifies an argument for the new prompt answer for WebConstantPrompt in document drilling.

    4220

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER

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

    3132

    EnumServletEvents.WebEventForwardToRWExport

    documentID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    documentName

    Object name.

    2048020

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_OBJECT_NAME

    elementsPromptAnswers

    Specifies element prompts' answers in a URL friendly format.

    2048089

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

    executionFlags

    Execution flags

    2048003

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXEC_FLAGS

    executionMode

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

    3115

    EnumServletEvents.WebEventArgumentRWExecutionMode

    freshExec

    Argument indicating whether the RW document to be executed with fresh-execution related execution flags.

    2048060

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_REEXECUTE_FRESH

    gridKey

    Section key.

    2048007

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SECTION_KEY

    maxWait

    Max time in milliseconds to wait for event execution. A value of -1 means wait indefinitely.

    2048093

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_MAX_WAIT

    messageID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • 3010

    EnumServletEvents.WebEventArgumentMessageID

    originMessageID

    Specifies the message ID of the original Document (HTML or RW) whose prompt answers are going to be retrieved.

    2048087

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

    pollingFreq

    Polling frequency.

    2048094

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_POLLING_FREQUENCY

    promptAnswerMode

    An integer prompt answer mode from EnumWebPromptAnswerMode

    2048201

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PROMPT_ANSWER_MODE_OPTION

    promptsAnswerXML

    Specifies the prompt answer XML from the original Document (HTML or RW).

    2048088

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

    sliceId

    3152

    EnumServletEvents.WebEventArgumentSliceId

    subscriptionID

    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:
  • EnumServletEvents.WebEventReportWritingDocumentPDFFastExport
  • 3107

    EnumServletEvents.WebEventArgumentSubscriptionID

    triggerID

    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:
  • EnumServletEvents.WebEventEditSubscription
  • 3029

    EnumServletEvents.WebEventArgumentTriggerID

    useDefAns

    Whether to use default prompt answers.

    2048103

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_USE_DEFAULT_PROMPT_ANSWERS

    valuePromptAnswers

    Specifies an argument for the new prompt answer for WebConstantPrompt in document drilling.

    2048132

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER

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

    3017

    EnumServletEvents.WebEventGeneric

    getChangePwd
    Event for changing user's password.

    3042

    EnumServletEvents.WebEventCallChangePassword

    cptarget

    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:
  • EnumServletEvents.WebEventOpenPage
  • EnumServletEvents.WebEventLogout
  • EnumServletEvents.WebEventReturnTo
  • EnumServletEvents.WebEventProcessLogin
  • 3004

    EnumServletEvents.WebEventArgumentTarget

    Port

    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:
  • EnumServletEvents.WebEventOpenDesktop
  • EnumServletEvents.WebEventCallChangePassword
  • EnumServletEvents.WebEventProcessLogin
  • 3023

    EnumServletEvents.WebEventArgumentPortNumber

    Server

    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:
  • EnumServletEvents.WebEventOpenDesktop
  • EnumServletEvents.WebEventCallChangePassword
  • EnumServletEvents.WebEventProcessLogin
  • 3021

    EnumServletEvents.WebEventArgumentServerName

    Uid

    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:
  • EnumServletEvents.WebEventCallChangePassword
  • 3036

    EnumServletEvents.WebEventArgumentUserName

    getDocumentDetails
    Event for getting the document details.

    3020

    EnumServletEvents.WebEventGetDocumentDetails

    allowExecute

    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:
  • EnumServletEvents.WebEventArgumentAllowExecute
    Usage:
  • '0' : don't allow execution.
  • '1' : allow execution.
  • 3016

    EnumServletEvents.WebEventArgumentAllowExecute

    documentID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    messageID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • 3010

    EnumServletEvents.WebEventArgumentMessageID

    viewMode

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

    EnumServletEvents.WebEventArgumentDocumentViewMode

    getReportDetails
    Event for getting the report details.

    3021

    EnumServletEvents.WebEventGetReportDetails

    allowExecute

    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:
  • EnumServletEvents.WebEventArgumentAllowExecute
    Usage:
  • '0' : don't allow execution.
  • '1' : allow execution.
  • 3016

    EnumServletEvents.WebEventArgumentAllowExecute

    messageID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • 3010

    EnumServletEvents.WebEventArgumentMessageID

    reportID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    reportparentFolderID

    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:
  • EnumServletEvents.WebEventSaveAs
  • 3014

    EnumServletEvents.WebEventArgumentReportParentFolderID

    stateID

    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:
  • EnumServletEvents.WebEventGetReportDetails
  • 3015

    EnumServletEvents.WebEventArgumentReportStateID

    graphDrillFromDocumentToReport
    Event for graph drilling from a document to a report.

    3126

    EnumServletEvents.WebEventGraphDrillFromDocToReport

    3126.x

    Specifies the X pixel offset for graph drill Used in following event:
  • EnumServletEvents.WebEventGraphDrillFromDocToReport
  • 3147

    EnumServletEvents.WebEventArgumentDrillGraphPixelX

    3126.y

    Specifies the Y pixel offset for graph drill Used in following event:
  • EnumServletEvents.WebEventGraphDrillFromDocToReport
  • 3148

    EnumServletEvents.WebEventArgumentDrillGraphPixelY

    displayMode

    Specifies the display mode. A value from the enumeration EnumDSSXMLDisplayMode Used in following event:
  • EnumServletEvents.WebEventGraphDrillFromDocToReport
  • 3146

    EnumServletEvents.WebEventArgumentDrillDisplayMode

    drillPathKey

    Argument to specify drill path key.
    Used in following event:
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • EnumServletEvents.WebEventGraphDrillFromDocToReport
  • 3141

    EnumServletEvents.WebEventArgumentDrillPathKey

    graphHeight

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

    EnumServletEvents.WebEventArgumentGraphHeight

    graphWidth

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

    EnumServletEvents.WebEventArgumentGraphWidth

    retainParent

    Specifies whether the parent should be kept after performing the drill operation. Used in following event:
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • EnumServletEvents.WebEventGraphDrillFromDocToReport
  • 3142

    EnumServletEvents.WebEventArgumentDrillRetainParent

    retainThresh

    specifies whether the thresholds should be kept after performing the drill operation. Used in following event:
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • EnumServletEvents.WebEventGraphDrillFromDocToReport
  • 3144

    EnumServletEvents.WebEventArgumentDrillRetainThreshold

    rwGroupByElements

    Specifies the list of page by elements in the report writing document. These are separated by EnumReportBeanEvents.METRIC_ELEM_LIST_SEPARATOR. Used in the following events:
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • EnumServletEvents.WebEventGraphDrillFromDocToReport
  • EnumServletEvents.WebEventDrillToFixedTemplateFromDocToReport
    When drilling from a report writing document to a grid outside the document, the page by elements are required to set the current element on the page by of the resulting grid.
  • 3151

    EnumServletEvents.WebEventArgumentRWPageByElements

    rwMesageID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • 3010

    EnumServletEvents.WebEventArgumentMessageID

    sliceId

    3152

    EnumServletEvents.WebEventArgumentSliceId

    gridDrillFromDocumentToReport
    Event for grid drilling from a document to a report.

    3125

    EnumServletEvents.WebEventGridDrillFromDocToReport

    displayMode

    Specifies the display mode. A value from the enumeration EnumDSSXMLDisplayMode Used in following event:
  • EnumServletEvents.WebEventGraphDrillFromDocToReport
  • 3146

    EnumServletEvents.WebEventArgumentDrillDisplayMode

    drillPathKey

    Argument to specify drill path key.
    Used in following event:
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • EnumServletEvents.WebEventGraphDrillFromDocToReport
  • 3141

    EnumServletEvents.WebEventArgumentDrillPathKey

    elementList

    Argument to specify element list to filter on while drilling.
    Used in following event:
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • 3143

    EnumServletEvents.WebEventArgumentDrillElementList

    filterOnPageBy

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

    EnumServletEvents.WebEventArgumentDrillFilterOnPageBy

    retainParent

    Specifies whether the parent should be kept after performing the drill operation. Used in following event:
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • EnumServletEvents.WebEventGraphDrillFromDocToReport
  • 3142

    EnumServletEvents.WebEventArgumentDrillRetainParent

    retainThresh

    specifies whether the thresholds should be kept after performing the drill operation. Used in following event:
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • EnumServletEvents.WebEventGraphDrillFromDocToReport
  • 3144

    EnumServletEvents.WebEventArgumentDrillRetainThreshold

    rwGroupByElements

    Specifies the list of page by elements in the report writing document. These are separated by EnumReportBeanEvents.METRIC_ELEM_LIST_SEPARATOR. Used in the following events:
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • EnumServletEvents.WebEventGraphDrillFromDocToReport
  • EnumServletEvents.WebEventDrillToFixedTemplateFromDocToReport
    When drilling from a report writing document to a grid outside the document, the page by elements are required to set the current element on the page by of the resulting grid.
  • 3151

    EnumServletEvents.WebEventArgumentRWPageByElements

    rwMesageID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • 3010

    EnumServletEvents.WebEventArgumentMessageID

    sliceId

    3152

    EnumServletEvents.WebEventArgumentSliceId

    htmlMenu
    Event for handling menu selections when HTML mode is on.

    3027

    EnumServletEvents.WebEventHTMLMenu

    check

    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:
  • EnumServletEvents.WebEventHTMLMenu
  • 3019

    EnumServletEvents.WebEventArgumentMenuID

    menu

    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:
  • EnumServletEvents.WebEventHTMLMenu
  • 3020

    EnumServletEvents.WebEventArgumentMenuOptionID

    promptStyle

    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.

    30051

    EnumServletEvents.WebEventArgumentPromptStyle

    inbox
    Event for opening the 'History list' page.

    3018

    EnumServletEvents.WebEventOpenHistoryList

    initializeFromSchedule
    Specifies an event to initialize the document bean using a schedule.

    32007

    EnumDocumentBeanEvents.DOCUMENT_EVENT_INITIALIZE_FROM_SCHEDULE

    *triggerID

    String argument indicating the trigger to be used.

    32203

    EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_TRIGGER_ID

    saveToInbox

    Specifies whether to save the message to inbox.

    32317

    EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SAVE_TO_INBOX

    targetID

    The target document ID for the schedule using which a document can be initialized

    32315

    EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_TARGET_ID

    initializeFromSchedule
    Event for initializing the report bean using a schedule.

    4057

    EnumReportBeanEvents.REPORT_EVENT_INITIALIZE_FROM_SCHEDULE

    *triggerID

    String argument indicating the trigger to be used.

    4127

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TRIGGER_ID

    promptStyle

    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.

    30051

    EnumServletEvents.WebEventArgumentPromptStyle

    reportViewMode

    integer argument of EnumWebReportViewMode specifying the report view mode.

    4115

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_VIEW_MODE

    saveToInbox

    Specifies whether to save the message to inbox.

    4172

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SAVE_TO_INBOX

    targetID

    Argument indicating the target object to be used to initialize the report bean using a schedule.

    4162

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TARGET_ID

    initializeFromSchedule
    Event for initializing the RW Bean with a schedule.

    2048025

    EnumRWBeanEvents.REPORT_WRITER_EVENT_INITIALIZE_FROM_SCHEDULE

    *triggerID

    The trigger ID for scheduling/subscription.

    2048048

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TRIGGER_ID

    targetID

    Target object ID for initializing a RW Bean with Schedule

    2048057

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_TARGET_ID

    initializeFromSubscription
    Specifies an event to initialize the document bean using a subscription.

    32008

    EnumDocumentBeanEvents.DOCUMENT_EVENT_INITIALIZE_FROM_SUBSCRIPTION

    *_subscriptionID

    The subscription ID for the subscription using which a document can be initialized

    32316

    EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SUBSCRIPTION_ID

    saveToInbox

    Specifies whether to save the message to inbox.

    32317

    EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_SAVE_TO_INBOX

    initializeFromSubscription
    Event for initializing the report bean using a subscription.

    4058

    EnumReportBeanEvents.REPORT_EVENT_INITIALIZE_FROM_SUBSCRIPTION

    *_subscriptionID

    Argument indicating the target object to be used to initialize the report bean using a subscription.

    4163

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_ID

    promptStyle

    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.

    30051

    EnumServletEvents.WebEventArgumentPromptStyle

    reportViewMode

    integer argument of EnumWebReportViewMode specifying the report view mode.

    4115

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_VIEW_MODE

    saveToInbox

    Specifies whether to save the message to inbox.

    4172

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SAVE_TO_INBOX

    initializeFromSubscription
    Event for initializing the RW Bean with a subscription.

    2048026

    EnumRWBeanEvents.REPORT_WRITER_EVENT_INITIALIZE_FROM_SUBSCRIPTION

    *subscriptionID

    Subscription ID for initializing a RW Bean with Subscription

    2048058

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_ID

    initializeHTML5VIFromSubscription
    Event to handle opening a HTML5 VI subscription.

    3186

    EnumServletEvents.WebEventInitializeHTML5VIFromSubscription

    *subscriptionID

    Subscription ID for initializing a RW Bean with Subscription

    2048058

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_ID

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

    3056

    EnumServletEvents.WebEventLoadGraph

    graphHeight

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

    EnumServletEvents.WebEventArgumentGraphHeight

    graphWidth

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

    EnumServletEvents.WebEventArgumentGraphWidth

    ignoreGraphHeightWidth

    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:
  • EnumServletEvents.WebEventLoadGraph
  • 3127

    EnumServletEvents.WebEventArgumentIgnoreGraphHeightWidth

    messageID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • 3010

    EnumServletEvents.WebEventArgumentMessageID

    reportID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    requestId

    3137

    EnumServletEvents.WebEventArgumentGraphRequestId

    shrinkGraphToHeight

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

    EnumServletEvents.WebEventArgumentGraphShrinkHeight

    shrinkGraphToWidth

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

    EnumServletEvents.WebEventArgumentGraphShrinkWidth

    logout
    Event for logging out the application.

    3008

    EnumServletEvents.WebEventLogout

    state

    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:
  • EnumServletEvents.WebEventOpenPage
    Usage:
    One usage for this argument has to do with BrowserSettings. Value for this parameter is obtained by calling getSessionValue() function in BrowserSettings, which takes a parameter value defined in EnumWebBrowserSettings
  • 3018

    EnumServletEvents.WebEventArgumentBeansState

    target

    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:
  • EnumServletEvents.WebEventOpenPage
  • EnumServletEvents.WebEventLogout
  • EnumServletEvents.WebEventReturnTo
  • EnumServletEvents.WebEventProcessLogin
  • 3004

    EnumServletEvents.WebEventArgumentTarget

    ncAddCacheSubscription
    Event to add a cache subscription

    3196

    EnumServletEvents.WebEventAddCacheSubscription

    messageID

    Argument specifying the message ID.

    256006

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_MESSAGE_ID

    objectID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    objectSubType

    Integer argument to specify a content's subtype

    256075

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_SUBTYPE

    objectType

    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:
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • 3007

    EnumServletEvents.WebEventArgumentObjectType

    viewMode

    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:
  • EnumServletEvents.WebEventEditReport
    The value for this parameter is specified in EnumWebReportViewMode
  • 3005

    EnumServletEvents.WebEventArgumentReportViewMode

    ncAddFileSubscription
    Event to open the page of Narrowcast Server print addresses.

    3074

    EnumServletEvents.WebEventNCAddFileSubscription

    objectID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    objectType

    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:
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • 3007

    EnumServletEvents.WebEventArgumentObjectType

    viewMode

    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:
  • EnumServletEvents.WebEventEditReport
    The value for this parameter is specified in EnumWebReportViewMode
  • 3005

    EnumServletEvents.WebEventArgumentReportViewMode

    ncAddFTPSubscription
    Event to open the page of Narrowcast Server FTP addresses.

    3078

    EnumServletEvents.WebEventNCAddFTPSubscription

    objectID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    objectType

    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:
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • 3007

    EnumServletEvents.WebEventArgumentObjectType

    viewMode

    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:
  • EnumServletEvents.WebEventEditReport
    The value for this parameter is specified in EnumWebReportViewMode
  • 3005

    EnumServletEvents.WebEventArgumentReportViewMode

    ncAddInboxSubscription
    Event to add a subscription to the history list

    3128

    EnumServletEvents.WebEventAddInboxSubscription

    messageID

    Argument specifying the message ID.

    256006

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_MESSAGE_ID

    objectID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    objectSubType

    Integer argument to specify a content's subtype

    256075

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_SUBTYPE

    objectType

    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:
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • 3007

    EnumServletEvents.WebEventArgumentObjectType

    viewMode

    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:
  • EnumServletEvents.WebEventEditReport
    The value for this parameter is specified in EnumWebReportViewMode
  • 3005

    EnumServletEvents.WebEventArgumentReportViewMode

    ncAddMobileSubscription
    Event to add a mobile subscription

    3134

    EnumServletEvents.WebEventAddMobileSubscription

    objectID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    objectType

    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:
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • 3007

    EnumServletEvents.WebEventArgumentObjectType

    viewMode

    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:
  • EnumServletEvents.WebEventEditReport
    The value for this parameter is specified in EnumWebReportViewMode
  • 3005

    EnumServletEvents.WebEventArgumentReportViewMode

    ncAddPersonalViewSubscription

    3174

    EnumServletEvents.WebEventAddPersonalViewSubscription

    objectID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    objectType

    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:
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • 3007

    EnumServletEvents.WebEventArgumentObjectType

    ncAddPrintSubscription
    Event to open the page of Narrowcast Server print addresses.

    3076

    EnumServletEvents.WebEventNCAddPrintSubscription

    objectID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    objectType

    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:
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • 3007

    EnumServletEvents.WebEventArgumentObjectType

    viewMode

    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:
  • EnumServletEvents.WebEventEditReport
    The value for this parameter is specified in EnumWebReportViewMode
  • 3005

    EnumServletEvents.WebEventArgumentReportViewMode

    ncAddresses
    Event to open the page of Narrowcast Server email addresses.

    3038

    EnumServletEvents.WebEventNCAddresses

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

    3036

    EnumServletEvents.WebEventNCAddSubscription

    _subscriptionID

    Argument specifying the subscription ID.

    256001

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_ID

    addressID

    Argument specifying the address ID.

    As of MicroStrategy Web 8.0.1, setting this argument will clear all other addresses in SubscriptionBean.getAddresses().

    256003

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID

    addressType

    When set to 1, new subscriptions are created with addresses EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES. Otherwise, on a 0, existing address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID is used instead. If a value is not specified for this argument, then both EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES and EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID arguments are used

    256013

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_INPUT_TYPE

    addressValues

    argument specifying a list of addresses.

    256008

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES

    cmsg

    Message to be saved along with the email subscription.

    256015

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CUSTOM_MESSAGE

    deviceID

    Argument specifying the ID of the device.

    256009

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_DEVICE_ID

    editMode

    Denotes the edit mode. Should be a value from EnumWebSubscriptionEditModes

    256012

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EDIT_MODE

    elementsPromptAnswers

    Plain element prompt answer.

    256029

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

    emailSubject

    Argument specifying the email subject.

    256010

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EMAIL_SUBJECT

    fstate

    The serialized state of the delivery format.

    256016

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_FORMAT_STATE

    messageID

    Argument specifying the message ID.

    256006

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_MESSAGE_ID

    objectID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    objectType

    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:
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • 3007

    EnumServletEvents.WebEventArgumentObjectType

    originMessageID

    Origin message ID.

    256027

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

    promptsAnswerXML

    Origin short answer XML.

    256028

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

    sendNow

    Argument specifying whether send now should be set.

    256011

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SEND_NOW

    stateID

    Argument specifying the state ID.

    256007

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_STATE_ID

    triggerID

    Argument specifying the trigger ID.

    256002

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_TRIGGER_ID

    viewMode

    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:
  • EnumServletEvents.WebEventEditReport
    The value for this parameter is specified in EnumWebReportViewMode
  • 3005

    EnumServletEvents.WebEventArgumentReportViewMode

    zip

    Indicates whether the format should be zipped.

    256017

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ZIP_CONTENTS

    ncEditCacheSubscription
    Event to edit a cache subscription

    3197

    EnumServletEvents.WebEventEditCacheSubscription

    _subscriptionID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    editMode

    Denotes the edit mode. Should be a value from EnumWebSubscriptionEditModes

    256012

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EDIT_MODE

    ncEditFileSubscription
    Event to open the page of Narrowcast Server print addresses.

    3073

    EnumServletEvents.WebEventNCEditFileSubscription

    _subscriptionID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    editMode

    Denotes the edit mode. Should be a value from EnumWebSubscriptionEditModes

    256012

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EDIT_MODE

    ncEditFTPSubscription
    Event to open the page of Narrowcast Server FTP addresses.

    3077

    EnumServletEvents.WebEventNCEditFTPSubscription

    _subscriptionID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    editMode

    Denotes the edit mode. Should be a value from EnumWebSubscriptionEditModes

    256012

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EDIT_MODE

    ncEditInboxSubscription
    Event to edit a history list subscription

    3129

    EnumServletEvents.WebEventEditInboxSubscription

    _subscriptionID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    editMode

    Denotes the edit mode. Should be a value from EnumWebSubscriptionEditModes

    256012

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EDIT_MODE

    ncEditMobileSubscription
    Event to edit a mobile subscription

    3133

    EnumServletEvents.WebEventEditMobileSubscription

    _subscriptionID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    editMode

    Denotes the edit mode. Should be a value from EnumWebSubscriptionEditModes

    256012

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EDIT_MODE

    ncEditPersonalViewSubscription

    3173

    EnumServletEvents.WebEventEditPersonalViewSubscription

    _subscriptionID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    editMode

    Denotes the edit mode. Should be a value from EnumWebSubscriptionEditModes

    256012

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EDIT_MODE

    ncEditPrintSubscription
    Event to open the page of Narrowcast Server print addresses.

    3075

    EnumServletEvents.WebEventNCEditPrintSubscription

    _subscriptionID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    editMode

    Denotes the edit mode. Should be a value from EnumWebSubscriptionEditModes

    256012

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EDIT_MODE

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

    3035

    EnumServletEvents.WebEventNCEditSubscription

    _subscriptionID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    addressID

    Argument specifying the address ID.

    As of MicroStrategy Web 8.0.1, setting this argument will clear all other addresses in SubscriptionBean.getAddresses().

    256003

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID

    addressType

    When set to 1, new subscriptions are created with addresses EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES. Otherwise, on a 0, existing address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID is used instead. If a value is not specified for this argument, then both EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES and EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID arguments are used

    256013

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_INPUT_TYPE

    addressValues

    argument specifying a list of addresses.

    256008

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES

    cmsg

    Message to be saved along with the email subscription.

    256015

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CUSTOM_MESSAGE

    deviceID

    Argument specifying the ID of the device.

    256009

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_DEVICE_ID

    editMode

    Denotes the edit mode. Should be a value from EnumWebSubscriptionEditModes

    256012

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EDIT_MODE

    elementsPromptAnswers

    Plain element prompt answer.

    256029

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

    emailSubject

    Argument specifying the email subject.

    256010

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EMAIL_SUBJECT

    fstate

    The serialized state of the delivery format.

    256016

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_FORMAT_STATE

    messageID

    Argument specifying the message ID.

    256006

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_MESSAGE_ID

    objectID

    Argument specifying the content object ID.

    256004

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_ID

    objectType

    Argument specifying the content object type (see EnumDSSXMLObjectTypes).

    256005

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_TYPE

    originMessageID

    Origin message ID.

    256027

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

    promptsAnswerXML

    Origin short answer XML.

    256028

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

    sendNow

    Argument specifying whether send now should be set.

    256011

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SEND_NOW

    stateID

    Argument specifying the state ID.

    256007

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_STATE_ID

    triggerID

    Argument specifying the trigger ID.

    256002

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_TRIGGER_ID

    vmode

    Specifies the view mode for the report EnumWebReportViewMode.

    256014

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_VIEW_MODE

    zip

    Indicates whether the format should be zipped.

    256017

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ZIP_CONTENTS

    ncFileAddresses
    Event to open the page of Narrowcast Server file addresses.

    3071

    EnumServletEvents.WebEventNCFileAddresses

    ncFTPAddresses
    Event to open the page of Narrowcast Server FTP addresses.

    3079

    EnumServletEvents.WebEventNCFTPAddresses

    ncPrintAddresses
    Event to open the page of Narrowcast Server print addresses.

    3072

    EnumServletEvents.WebEventNCPrintAddresses

    ncSendNow
    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.

    3037

    EnumServletEvents.WebEventNCSendNow

    _subscriptionID

    Argument specifying the subscription ID.

    256001

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_ID

    addressID

    Argument specifying the address ID.

    As of MicroStrategy Web 8.0.1, setting this argument will clear all other addresses in SubscriptionBean.getAddresses().

    256003

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID

    addressType

    When set to 1, new subscriptions are created with addresses EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES. Otherwise, on a 0, existing address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID is used instead. If a value is not specified for this argument, then both EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES and EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID arguments are used

    256013

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_INPUT_TYPE

    addressValues

    argument specifying a list of addresses.

    256008

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES

    cmsg

    Message to be saved along with the email subscription.

    256015

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CUSTOM_MESSAGE

    deviceID

    Argument specifying the ID of the device.

    256009

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_DEVICE_ID

    editMode

    Denotes the edit mode. Should be a value from EnumWebSubscriptionEditModes

    256012

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EDIT_MODE

    elementsPromptAnswers

    Plain element prompt answer.

    256029

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

    emailSubject

    Argument specifying the email subject.

    256010

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EMAIL_SUBJECT

    fstate

    The serialized state of the delivery format.

    256016

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_FORMAT_STATE

    messageID

    Argument specifying the message ID.

    256006

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_MESSAGE_ID

    objectID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    objectSubType

    Integer argument to specify a content's subtype

    256075

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_SUBTYPE

    objectType

    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:
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • 3007

    EnumServletEvents.WebEventArgumentObjectType

    originMessageID

    Origin message ID.

    256027

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

    promptsAnswerXML

    Origin short answer XML.

    256028

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

    sendNow

    Argument specifying whether send now should be set.

    256011

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SEND_NOW

    stateID

    Argument specifying the state ID.

    256007

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_STATE_ID

    triggerID

    Argument specifying the trigger ID.

    256002

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_TRIGGER_ID

    viewMode

    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:
  • EnumServletEvents.WebEventEditReport
    The value for this parameter is specified in EnumWebReportViewMode
  • 3005

    EnumServletEvents.WebEventArgumentReportViewMode

    zip

    Indicates whether the format should be zipped.

    256017

    EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ZIP_CONTENTS

    ncSendNowConfirm
    Event for showing confirmation page for NCS send now subscriptions.

    3108

    EnumServletEvents.WebEventNCSendNowConfirm

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

    3107

    EnumServletEvents.WebEventNCSubsConfirm

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

    3004

    EnumServletEvents.WebEventOpenPage

    clear

    3162

    EnumServletEvents.WebEventArgumentClearPage

    fromPageHistory

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

    3173

    EnumServletEvents.WebEventArgumentFromPageHistory

    state

    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:
  • EnumServletEvents.WebEventOpenPage
    Usage:
    One usage for this argument has to do with BrowserSettings. Value for this parameter is obtained by calling getSessionValue() function in BrowserSettings, which takes a parameter value defined in EnumWebBrowserSettings
  • 3018

    EnumServletEvents.WebEventArgumentBeansState

    target

    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:
  • EnumServletEvents.WebEventOpenPage
  • EnumServletEvents.WebEventLogout
  • EnumServletEvents.WebEventReturnTo
  • EnumServletEvents.WebEventProcessLogin
  • 3004

    EnumServletEvents.WebEventArgumentTarget

    openAbout
    Event for opening 'About' page.

    3048

    EnumServletEvents.WebEventOpenAbout

    openAdminFAQs
    Event for opening the Administrator frequently asked questions page.

    3064

    EnumServletEvents.WebEventOpenAdminFAQs

    isAdminHelp

    Used in following event:
  • EnumServletEvents.WebEventOpenAdminFAQs
  • EnumServletEvents.WebEventOpenAdminHelp
  • EnumServletEvents.WebEventOpenAdminHelpIndex
  • 3102

    EnumServletEvents.WebEventArgumentIsAdminHelp

    subpage

    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:
  • EnumServletEvents.WebEventOpenHelp
  • 3037

    EnumServletEvents.WebEventArgumentSubPage

    openAdminHelp
    Event for opening the Administrator online help page.

    3065

    EnumServletEvents.WebEventOpenAdminHelp

    isAdminHelp

    Used in following event:
  • EnumServletEvents.WebEventOpenAdminFAQs
  • EnumServletEvents.WebEventOpenAdminHelp
  • EnumServletEvents.WebEventOpenAdminHelpIndex
  • 3102

    EnumServletEvents.WebEventArgumentIsAdminHelp

    subpage

    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:
  • EnumServletEvents.WebEventOpenHelp
  • 3037

    EnumServletEvents.WebEventArgumentSubPage

    openAdminHelpIndex
    Event for opening the Administrator online help index.

    3066

    EnumServletEvents.WebEventOpenAdminHelpIndex

    isAdminHelp

    Used in following event:
  • EnumServletEvents.WebEventOpenAdminFAQs
  • EnumServletEvents.WebEventOpenAdminHelp
  • EnumServletEvents.WebEventOpenAdminHelpIndex
  • 3102

    EnumServletEvents.WebEventArgumentIsAdminHelp

    subpage

    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:
  • EnumServletEvents.WebEventOpenHelp
  • 3037

    EnumServletEvents.WebEventArgumentSubPage

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

    3055

    EnumServletEvents.WebEventAdminOpenHome

    showDefault

    Used in following event:
  • EnumServletEvents.WebEventAdminOpenHome
  • 3099

    EnumServletEvents.WebEventArgumentShowDefault

    showServerProps

    Used in following event:
  • EnumServletEvents.WebEventAdminOpenHome
  • 3100

    EnumServletEvents.WebEventArgumentShowServerProperties

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

    3057

    EnumServletEvents.WebEventOpenPDFSaveReportProperties

    showDefault

    Used in following event:
  • EnumServletEvents.WebEventAdminOpenHome
  • 3099

    EnumServletEvents.WebEventArgumentShowDefault

    showServerProps

    Used in following event:
  • EnumServletEvents.WebEventAdminOpenHome
  • 3100

    EnumServletEvents.WebEventArgumentShowServerProperties

    openAnalysis

    3169

    documentID

    3001

    executionMode

    3115

    messageID

    3010

    objectType

    3007

    rwDesignMode

    3017

    rwViewMode

    3158

    openAppSchemaPage
    Event for opening Application Schema page

    3199

    EnumServletEvents.WebEventOpenAppSchemaPage

    cubeID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    openCreate
    Event for opening 'Create Reports' folder.

    3011

    EnumServletEvents.WebEventOpenCreate

    folderID

    Specifies the object ID of a WebFolder.

    1001

    EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_FOLDER_ID

    parentFolderId

    3185

    EnumServletEvents.WebEventArgumentParentFolderId

    systemFolder

    Specifies the system folder to browse into.

    2023

    EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_SYS_FOLDER

    openCreateDocument
    Event for opening 'Create Document' page.

    3100

    EnumServletEvents.WebEventOpenCreateDocument

    folderID

    Specifies the object ID of a WebFolder.

    1001

    EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_FOLDER_ID

    parentFolderId

    3185

    EnumServletEvents.WebEventArgumentParentFolderId

    systemFolder

    Specifies the system folder to browse into.

    2023

    EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_SYS_FOLDER

    openCreatePrompt

    3123

    EnumServletEvents.WebEventOpenCreatePromptPage

    openDefaultDesktop
    Event for opening the 'Default Desktop' page.

    3060

    EnumServletEvents.WebEventOpenDefaultDesktop

    loginReq

    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:
  • EnumServletEvents.WebEventOpenDesktop
    Usage:
  • 'true' : enforce checking.
  • 'false' : don't perform checking.
  • 3024

    EnumServletEvents.WebEventArgumentCheckLogin

    Port

    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:
  • EnumServletEvents.WebEventOpenDesktop
  • EnumServletEvents.WebEventCallChangePassword
  • EnumServletEvents.WebEventProcessLogin
  • 3023

    EnumServletEvents.WebEventArgumentPortNumber

    Server

    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:
  • EnumServletEvents.WebEventOpenDesktop
  • EnumServletEvents.WebEventCallChangePassword
  • EnumServletEvents.WebEventProcessLogin
  • 3021

    EnumServletEvents.WebEventArgumentServerName

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

    3192

    EnumServletEvents.WebEventOpenDefaultHomePage

    loginReq

    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:
  • EnumServletEvents.WebEventOpenDesktop
    Usage:
  • 'true' : enforce checking.
  • 'false' : don't perform checking.
  • 3024

    EnumServletEvents.WebEventArgumentCheckLogin

    Port

    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:
  • EnumServletEvents.WebEventOpenDesktop
  • EnumServletEvents.WebEventCallChangePassword
  • EnumServletEvents.WebEventProcessLogin
  • 3023

    EnumServletEvents.WebEventArgumentPortNumber

    Project

    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:
  • EnumServletEvents.WebEventOpenDesktop
  • EnumServletEvents.WebEventProcessLogin
  • 3022

    EnumServletEvents.WebEventArgumentProjectName

    Server

    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:
  • EnumServletEvents.WebEventOpenDesktop
  • EnumServletEvents.WebEventCallChangePassword
  • EnumServletEvents.WebEventProcessLogin
  • 3021

    EnumServletEvents.WebEventArgumentServerName

    ServerAlias

    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:
  • EnumServletEvents.WebEventOpenDesktop
  • 3181

    EnumServletEvents.WebEventArgumentServerAlias

    openDeleteAddress
    Event for opening the 'Delete an address' page.

    3061

    EnumServletEvents.WebEventNCOpenDeleteAddress

    deliveryMode

    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:
  • EnumServletEvents.WebEventNCOpenDeleteAddress
  • 3108

    EnumServletEvents.WebEventArgumentSubscriptionDeliveryMode

    objectID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    openDesktop
    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.

    3054

    EnumServletEvents.WebEventProcessLogin

    ConnMode

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

    EnumServletEvents.WebEventArgumentAuthenticationMode

    FbToken

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

    EnumServletEvents.WebEventArgumentFacebookToken

    key

    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:
  • EnumServletEvents.WebEventProcessLogin
  • 3038

    EnumServletEvents.WebEventArgumentSessionKey

    LoginMode

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

    EnumServletEvents.WebEventArgumentLoginMode

    Port

    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:
  • EnumServletEvents.WebEventOpenDesktop
  • EnumServletEvents.WebEventCallChangePassword
  • EnumServletEvents.WebEventProcessLogin
  • 3023

    EnumServletEvents.WebEventArgumentPortNumber

    Project

    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:
  • EnumServletEvents.WebEventOpenDesktop
  • EnumServletEvents.WebEventProcessLogin
  • 3022

    EnumServletEvents.WebEventArgumentProjectName

    Pwd

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

    EnumServletEvents.WebEventArgumentUserPassword

    Server

    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:
  • EnumServletEvents.WebEventOpenDesktop
  • EnumServletEvents.WebEventCallChangePassword
  • EnumServletEvents.WebEventProcessLogin
  • 3021

    EnumServletEvents.WebEventArgumentServerName

    target

    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:
  • EnumServletEvents.WebEventOpenPage
  • EnumServletEvents.WebEventLogout
  • EnumServletEvents.WebEventReturnTo
  • EnumServletEvents.WebEventProcessLogin
  • 3004

    EnumServletEvents.WebEventArgumentTarget

    tsvc

    Argument for the two step verification code used during login.

    3183

    EnumServletEvents.WebEventArgumentTwoStepVerificationCode

    Uid

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

    EnumServletEvents.WebEventArgumentUserId

    openDesktop
    Event for opening 'Desktop' page.

    3010

    EnumServletEvents.WebEventOpenDesktop

    loginReq

    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:
  • EnumServletEvents.WebEventOpenDesktop
    Usage:
  • 'true' : enforce checking.
  • 'false' : don't perform checking.
  • 3024

    EnumServletEvents.WebEventArgumentCheckLogin

    Port

    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:
  • EnumServletEvents.WebEventOpenDesktop
  • EnumServletEvents.WebEventCallChangePassword
  • EnumServletEvents.WebEventProcessLogin
  • 3023

    EnumServletEvents.WebEventArgumentPortNumber

    Project

    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:
  • EnumServletEvents.WebEventOpenDesktop
  • EnumServletEvents.WebEventProcessLogin
  • 3022

    EnumServletEvents.WebEventArgumentProjectName

    Server

    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:
  • EnumServletEvents.WebEventOpenDesktop
  • EnumServletEvents.WebEventCallChangePassword
  • EnumServletEvents.WebEventProcessLogin
  • 3021

    EnumServletEvents.WebEventArgumentServerName

    ServerAlias

    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:
  • EnumServletEvents.WebEventOpenDesktop
  • 3181

    EnumServletEvents.WebEventArgumentServerAlias

    openDiagnostics
    Event for opening the 'Diagnostics configuration' page.

    3051

    EnumServletEvents.WebEventOpenDiagnostics

    show

    Used in following event:
  • EnumServletEvents.WebEventOpenDiagnostics
  • 3098

    EnumServletEvents.WebEventArgumentShow

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

    3168

    EnumServletEvents.WebEventPrefDynamicAddresseList

    openExport
    Event for opening 'Export' page.

    3012

    EnumServletEvents.WebEventOpenExport

    defaultRunMode

    3157

    EnumServletEvents.WebEventArgumentExportDefaultRunMode

    exportExpandPageByFields

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

    EnumServletEvents.WebEventArgumentExportExpandPageByFields

    exportFilterDetails

    Argument to specify whether to export the filter details.
    Used in following event:
  • EnumServletEvents.WebEventOpenExport
  • 3124

    EnumServletEvents.WebEventArgumentexportFilterDetails

    exportFormatGraphs

    Argument to specify the export format name for graphs. Used in following event:
  • EnumServletEvents.WebEventOpenExport
  • 3120

    EnumServletEvents.WebEventArgumentExportFormatNameGraphs

    exportFormatGrids

    Argument to specify the export format name for grids. Used in following event:
  • EnumServletEvents.WebEventOpenExport
  • 3119

    EnumServletEvents.WebEventArgumentExportFormatNameGrids

    exportHeadersAsText

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

    EnumServletEvents.WebEventArgumentExportHeadersAsText

    exportMetricValuesAsText

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

    EnumServletEvents.WebEventArgumentExportMetricValuesAsText

    exportOverlapGridTitles

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

    EnumServletEvents.WebEventArgumentExportOverlapGridTitles

    exportPlaintextDelimiter

    Argument to specify the text delimiter for exporting to Plaintext. Used in following event:
  • EnumServletEvents.WebEventOpenExport
  • 3121

    EnumServletEvents.WebEventArgumentExportTextDelimiter

    exportReportOfficeRefresh

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

    EnumServletEvents.WebEventArgumentExportOfficeRefresh

    exportSection

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

    EnumServletEvents.WebEventArgumentExportSection

    exportUseLiveChartGraphs

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

    EnumServletEvents.WebEventArgumentExportUseLiveChartGraphs

    exportUseSeparateSheets

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

    EnumServletEvents.WebEventArgumentExportUseSeparateSheets

    PDFOutlineModeState

    Argument to specify the Outline Mode state. Used in following event:
  • EnumServletEvents.WebEventPDFDisplay
  • 3114

    EnumServletEvents.WebEventArgumentPDFOutlineModeState

    savePreferences

    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:
  • EnumServletEvents.WebEventOpenExport
  • 3028

    EnumServletEvents.WebEventArgumentNotAskExportOptions

    openExportDocument
    Event for opening the 'Export document' page.

    3023

    EnumServletEvents.WebEventOpenExportDocument

    documentID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    messageID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • 3010

    EnumServletEvents.WebEventArgumentMessageID

    openExportOptions
    Event for opening the 'Export options' page.

    3022

    EnumServletEvents.WebEventOpenExportOptions

    group

    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:
  • EnumServletEvents.WebEventOpenPreferences
  • 3034

    EnumServletEvents.WebEventArgumentPreferenceGroup

    groupSet

    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:
  • EnumServletEvents.WebEventOpenPreferences
  • 3033

    EnumServletEvents.WebEventArgumentPreferenceGroupSet

    openExportOptionsFromReport
    Event for opening the export options page

    3068

    EnumServletEvents.WebEventOpenExportOptionsFromReport

    defaultRunMode

    3157

    EnumServletEvents.WebEventArgumentExportDefaultRunMode

    messageID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • 3010

    EnumServletEvents.WebEventArgumentMessageID

    PDFOutlineModeState

    Argument to specify the Outline Mode state. Used in following event:
  • EnumServletEvents.WebEventPDFDisplay
  • 3114

    EnumServletEvents.WebEventArgumentPDFOutlineModeState

    reportID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    reportViewMode

    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:
  • EnumServletEvents.WebEventEditReport
    The value for this parameter is specified in EnumWebReportViewMode
  • 3005

    EnumServletEvents.WebEventArgumentReportViewMode

    showOptionsPage

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

    EnumServletEvents.WebEventArgumentShowOptionsPage

    openExportSaveReportProperties
    Event for opening the ExportSaveReportProperties page.

    3111

    EnumServletEvents.WebEventExportSaveReportProperties

    updateParentWindow

    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:
  • EnumServletEvents.WebEventOpenPDFSaveReportProperties
  • EnumServletEvents.WebEventOpenPrintSaveReportProperties
  • 3128

    EnumServletEvents.WebEventArgumentUpdateParentWindow

    openFAQs
    Event for opening 'FAQs' page.

    3045

    EnumServletEvents.WebEventOpenFAQs

    subpage

    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:
  • EnumServletEvents.WebEventOpenHelp
  • 3037

    EnumServletEvents.WebEventArgumentSubPage

    openFilterEditor

    3113

    EnumServletEvents.WebEventOpenFilterEditor

    filterID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    folderId

    3135

    EnumServletEvents.WebEventArgumentFolderId

    isNew

    Argument to specify the identifier of the cube report Used in following event:
  • EnumServletEvents.WebEventEditReport
  • 3134

    EnumServletEvents.WebEventArgumentIsNew

    openHelp
    Event for opening 'Help' page.

    3046

    EnumServletEvents.WebEventOpenHelp

    subpage

    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:
  • EnumServletEvents.WebEventOpenHelp
  • 3037

    EnumServletEvents.WebEventArgumentSubPage

    openHelpIndex
    Event for opening 'Help Index' page.

    3047

    EnumServletEvents.WebEventOpenHelpIndex

    subpage

    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:
  • EnumServletEvents.WebEventOpenHelp
  • 3037

    EnumServletEvents.WebEventArgumentSubPage

    openHelpSetup
    Event for opening 'Help setup' page.

    3177

    EnumServletEvents.WebEventOpenHelpSetup

    openHistoryPage
    Event for opening a page from the page history

    3124

    EnumServletEvents.WebEventOpenHistoryPage

    relativePageNumber

    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:
  • EnumServletEvents.WebEventOpenHistoryPage
  • 3140

    EnumServletEvents.WebEventArgumentRelativePageNumber

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

    3001

    EnumServletEvents.WebEventOpenHome

    openHomeCards

    3194

    EnumServletEvents.WebEventOpenMyPage

    openImportEntryPage
    Open DataImport entry page

    3172

    EnumServletEvents.WebEventOpenImportWizardEntryPage

    analysisAddMode

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

    3171

    EnumServletEvents.WebEventArgumentAnalysisAddMode

    analysisID

    The Analysis Object ID

    3169

    EnumServletEvents.WebEventArgumentAnalysisID

    cubeID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    cubeName

    Indicates the cube name

    3172

    EnumServletEvents.WebEventArgumentCubeName

    documentID

    3176

    EnumServletEvents.WebEventArgumentDocumentID

    folderId

    3135

    EnumServletEvents.WebEventArgumentFolderId

    isEdit

    Whether we are editing a cube

    3168

    EnumServletEvents.WebEventArgumentIsCubeEdit

    isNew

    Argument to specify the identifier of the cube report Used in following event:
  • EnumServletEvents.WebEventEditReport
  • 3134

    EnumServletEvents.WebEventArgumentIsNew

    isNewAnalysis

    Indicates whether DI will launch the IVE editor directly

    3170

    EnumServletEvents.WebEventArgumentIsNewAnalysis

    isRepublish

    Whether we are republishing a cube

    3180

    EnumServletEvents.WebEventArgumentIsCubeRepublish

    messageID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • 3010

    EnumServletEvents.WebEventArgumentMessageID

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

    3137

    EnumServletEvents.WebEventOpenImportWizard

    analysisAddMode

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

    3171

    EnumServletEvents.WebEventArgumentAnalysisAddMode

    analysisID

    The Analysis Object ID

    3169

    EnumServletEvents.WebEventArgumentAnalysisID

    cubeID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    documentID

    3176

    EnumServletEvents.WebEventArgumentDocumentID

    folderId

    3135

    EnumServletEvents.WebEventArgumentFolderId

    isEdit

    Whether we are editing a cube

    3168

    EnumServletEvents.WebEventArgumentIsCubeEdit

    isNew

    Argument to specify the identifier of the cube report Used in following event:
  • EnumServletEvents.WebEventEditReport
  • 3134

    EnumServletEvents.WebEventArgumentIsNew

    isNewAnalysis

    Indicates whether DI will launch the IVE editor directly

    3170

    EnumServletEvents.WebEventArgumentIsNewAnalysis

    messageID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • 3010

    EnumServletEvents.WebEventArgumentMessageID

    openIPAEnvironmentDetails

    3190

    action

    3001

    openMy
    Event for opening 'My Reports' page.

    3003

    EnumServletEvents.WebEventOpenMyReports

    openMySubscriptions
    Event for opening the 'My Subscriptions' page.

    3031

    EnumServletEvents.WebEventOpenMySubscriptions

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

    3032

    EnumServletEvents.WebEventOpenObjectSubscriptions

    objectID_3032

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    objectType_3032

    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:
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • 3007

    EnumServletEvents.WebEventArgumentObjectType

    openOfficeSetup
    Event for opening the MicroStrategy Office Setup page.

    3110

    EnumServletEvents.WebEventOpenOfficeSetup

    openPDFOptions
    Event for opening the 'PDF options' page.

    3039

    EnumServletEvents.WebEventOpenPDFOptions

    group

    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:
  • EnumServletEvents.WebEventOpenPreferences
  • 3034

    EnumServletEvents.WebEventArgumentPreferenceGroup

    groupSet

    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:
  • EnumServletEvents.WebEventOpenPreferences
  • 3033

    EnumServletEvents.WebEventArgumentPreferenceGroupSet

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

    3053

    EnumServletEvents.WebEventOpenPDFOptionsFromReport

    group

    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:
  • EnumServletEvents.WebEventOpenPreferences
  • 3034

    EnumServletEvents.WebEventArgumentPreferenceGroup

    PDFOutlineModeState

    Argument to specify the Outline Mode state. Used in following event:
  • EnumServletEvents.WebEventPDFDisplay
  • 3114

    EnumServletEvents.WebEventArgumentPDFOutlineModeState

    showOptionsPage

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

    EnumServletEvents.WebEventArgumentShowOptionsPage

    openPrefChPwd

    3167

    openPreferences
    Event for opening the 'Preferences' page.

    3041

    EnumServletEvents.WebEventOpenPreferences

    group

    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:
  • EnumServletEvents.WebEventOpenPreferences
  • 3034

    EnumServletEvents.WebEventArgumentPreferenceGroup

    groupSet

    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:
  • EnumServletEvents.WebEventOpenPreferences
  • 3033

    EnumServletEvents.WebEventArgumentPreferenceGroupSet

    openPrint
    Event for opening the 'Print' page.

    3028

    EnumServletEvents.WebEventOpenPrint

    printAdminFooterFile

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

    EnumServletEvents.WebEventArgumentPrintAdminFooterFile

    printAdminHeaderFile

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

    EnumServletEvents.WebEventArgumentPrintAdminHeaderFile

    printCoverPageFilterDetails

    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:
  • EnumServletEvents.WebEventOpenPrint
  • 3081

    EnumServletEvents.WebEventArgumentPrintCoverPageFilterDetails

    printDefaultColsPerPage

    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:
  • EnumServletEvents.WebEventOpenPrint
  • 3089

    EnumServletEvents.WebEventArgumentPrintDefaultColsPerPage

    printDefaultRowsPerPage

    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:
  • EnumServletEvents.WebEventOpenPrint
  • 3087

    EnumServletEvents.WebEventArgumentPrintDefaultRowsPerPage

    printDisplayPopupPrintDialog

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

    EnumServletEvents.WebEventArgumentPrintDisplayPopupPrintDialog

    printExpandPagebyFields

    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:
  • EnumServletEvents.WebEventOpenPrint
  • 3084

    EnumServletEvents.WebEventArgumentPrintExpandPagebyFields

    printFitColsToPage

    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 EnumServletEvents.WebEventArgumentPrintScalingOption is set to PrintBean.SCALING_FIT_TO_PAGE_OPTION.
    Used in following event:
  • EnumServletEvents.WebEventOpenPrint
  • 3068

    EnumServletEvents.WebEventArgumentPrintFitColsToPage

    printFitRowsToPage

    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 EnumServletEvents.WebEventArgumentPrintScalingOption is set to PrintBean.SCALING_FIT_TO_PAGE_OPTION.
    Used in following event:
  • EnumServletEvents.WebEventOpenPrint
  • 3067

    EnumServletEvents.WebEventArgumentPrintFitRowsToPage

    printFooterCenterSection

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

    EnumServletEvents.WebEventArgumentPrintFooterCenterSection

    printFooterLeftSection

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

    EnumServletEvents.WebEventArgumentPrintFooterLeftSection

    printFooterRightSection

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

    EnumServletEvents.WebEventArgumentPrintFooterRightSection

    printGridColsPerPage

    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:
  • EnumServletEvents.WebEventOpenPrint
  • 3091

    EnumServletEvents.WebEventArgumentPrintGridColsPerPage

    printGridGraphSamePage

    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:
  • EnumServletEvents.WebEventOpenPrint
  • 3083

    EnumServletEvents.WebEventArgumentPrintGridGraphSamePage

    printGridRowsPerPage

    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:
  • EnumServletEvents.WebEventOpenPrint
  • 3090

    EnumServletEvents.WebEventArgumentPrintGridRowsPerPage

    printHeaderCenterSection

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

    EnumServletEvents.WebEventArgumentPrintHeaderCenterSection

    printHeaderLeftSection

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

    EnumServletEvents.WebEventArgumentPrintHeaderLeftSection

    printHeaderRightSection

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

    EnumServletEvents.WebEventArgumentPrintHeaderRightSection

    printMarginSizeBottom

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

    EnumServletEvents.WebEventArgumentPrintMarginSizeBottom

    printMarginSizeLeft

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

    EnumServletEvents.WebEventArgumentPrintMarginSizeLeft

    printMarginSizeRight

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

    EnumServletEvents.WebEventArgumentPrintMarginSizeRight

    printMarginSizeTop

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

    EnumServletEvents.WebEventArgumentPrintMarginSizeTop

    printMaxCellsPerBlock

    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:
  • EnumServletEvents.WebEventOpenPrint
  • 3075

    EnumServletEvents.WebEventArgumentPrintMaxCellsPerBlock

    printMaxColsPerPage

    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:
  • EnumServletEvents.WebEventOpenPrint
  • 3088

    EnumServletEvents.WebEventArgumentPrintMaxColsPerPage

    printMaxFooterSize

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

    EnumServletEvents.WebEventArgumentPrintMaxFooterSize

    printMaxGraphsPerBlock

    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:
  • EnumServletEvents.WebEventOpenPrint
  • 3076

    EnumServletEvents.WebEventArgumentPrintMaxGraphsPerBlock

    printMaxHeaderSize

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

    EnumServletEvents.WebEventArgumentPrintMaxHeaderSize

    printMaxRowsPerPage

    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:
  • EnumServletEvents.WebEventOpenPrint
  • 3086

    EnumServletEvents.WebEventArgumentPrintMaxRowsPerPage

    printOpenNewWindow

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

    EnumServletEvents.WebEventArgumentPrintOpenNewWindow

    printPaperOrientationOption

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

    EnumServletEvents.WebEventArgumentPrintPaperOrientationOption

    printPaperSize

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

    EnumServletEvents.WebEventArgumentPrintPaperSize

    printScalingOption

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

    EnumServletEvents.WebEventArgumentPrintScalingOption

    printShowOptionsOnPrint

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

    EnumServletEvents.WebEventArgumentPrintShowOptionsOnPrint

    printShrinkFontPercentage

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

    EnumServletEvents.WebEventArgumentPrintShrinkFontPercentage

    savePreferences

    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:
  • EnumServletEvents.WebEventOpenExport
  • 3028

    EnumServletEvents.WebEventArgumentNotAskExportOptions

    openPrintDocument
    Event for opening the 'Print document' page.

    3030

    EnumServletEvents.WebEventOpenPrintDocument

    openPrintOptions
    Event for opening the 'Print options' page.

    3029

    EnumServletEvents.WebEventOpenPrintOptions

    group

    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:
  • EnumServletEvents.WebEventOpenPreferences
  • 3034

    EnumServletEvents.WebEventArgumentPreferenceGroup

    groupSet

    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:
  • EnumServletEvents.WebEventOpenPreferences
  • 3033

    EnumServletEvents.WebEventArgumentPreferenceGroupSet

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

    3052

    EnumServletEvents.WebEventOpenPrintOptionsFromReport

    openPublicDashbord

    3189

    openPublicShare

    3191

    documentID

    2048001

    openRRAcceptanceForm
    Reserved for future use.

    3178

    EnumServletEvents.WebEventOpenRRQuoteAcceptanceForm

    openRRAccountSettings
    Reserved for future use.

    3179

    EnumServletEvents.WebEventOpenRRAccountSetting

    openRRUserImport
    Reserved for future use.

    3181

    EnumServletEvents.WebEventopenRRUserImport

    openRRUserManagement
    Reserved for future use.

    3180

    EnumServletEvents.WebEventOpenRRUserManagement

    openRWSaveAs
    Event for opening report writer 'Save as' page.

    3102

    EnumServletEvents.WebEventRWSaveAs

    applyChanges

    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

    parentFolderID

    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:
  • EnumServletEvents.WebEventSaveAs
  • 3014

    EnumServletEvents.WebEventArgumentReportParentFolderID

    saveAsOrigin

    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:
  • EnumServletEvents.WebEventSaveAs
    Its value is determined in SaveAsBean as follows:
  • SAVE_AS_FROM_REPORT
  • SAVE_AS_NC_SUBSCRIPTIONS
  • SAVE_AS_NC_SENDNOW
  • SAVE_AS_WEB_SCHEDULING
  • 3031

    EnumServletEvents.WebEventArgumentSaveAsOrigin

    saveAsReportSaveAsFlags

    Argument to specify the save as flags for the new report/filter/template. It can have a value from EnumDSSXMLReportSaveAsFlags

    26005

    EnumSaveAsEvents.WebEventArgumentSaveAsReportSaveAsFlags

    saveFromDesignMode

    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

    target

    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:
  • EnumServletEvents.WebEventOpenPage
  • EnumServletEvents.WebEventLogout
  • EnumServletEvents.WebEventReturnTo
  • EnumServletEvents.WebEventProcessLogin
  • 3004

    EnumServletEvents.WebEventArgumentTarget

    openSaveAs
    Event for opening 'Save as' page.

    3013

    EnumServletEvents.WebEventSaveAs

    applyChanges

    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

    parentFolderID

    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:
  • EnumServletEvents.WebEventSaveAs
  • 3014

    EnumServletEvents.WebEventArgumentReportParentFolderID

    saveAsOrigin

    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:
  • EnumServletEvents.WebEventSaveAs
    Its value is determined in SaveAsBean as follows:
  • SAVE_AS_FROM_REPORT
  • SAVE_AS_NC_SUBSCRIPTIONS
  • SAVE_AS_NC_SENDNOW
  • SAVE_AS_WEB_SCHEDULING
  • 3031

    EnumServletEvents.WebEventArgumentSaveAsOrigin

    saveAsOriginPath

    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.

    3159

    EnumServletEvents.WebEventArgumentSaveAsOriginPath

    saveAsShowContinueButton

    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:
  • EnumServletEvents.WebEventSaveAs
  • 3109

    EnumServletEvents.WebEventArgumentSaveAsShowContinueButton

    saveFromDesignMode

    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

    saveFromPrompt

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

    3160

    EnumServletEvents.WebEventArgumentIsFromPrompt

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

    3131

    EnumServletEvents.WebEventOpenSaveReportProperties

    actionType

    Specifies the type of action (AbstractOptionsTransform.ACTION_TYPE_PDF, AbstractOptionsTransform.ACTION_TYPE_PRINT, AbstractOptionsTransform.ACTION_TYPE_EXPORT) Used in following event:
  • EnumServletEvents.WebEventOpenSaveReportProperties
  • 3154

    EnumServletEvents.WebEventArgumentActionType

    eventToForwardTo

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

    EnumServletEvents.WebEventArgumentEventToForwardTo

    savePreferences

    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:
  • EnumServletEvents.WebEventOpenExport
  • 3028

    EnumServletEvents.WebEventArgumentNotAskExportOptions

    updateParentWindow

    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:
  • EnumServletEvents.WebEventOpenPDFSaveReportProperties
  • EnumServletEvents.WebEventOpenPrintSaveReportProperties
  • 3128

    EnumServletEvents.WebEventArgumentUpdateParentWindow

    openSearch
    Event to open the 'Search' page.

    3040

    EnumServletEvents.WebEventOpenSearch

    advanced

    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:
  • EnumServletEvents.WebEventOpenSearch
  • 3032

    EnumServletEvents.WebEventArgumentAdvancedOption

    folderId

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    folderType

    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:
  • EnumServletEvents.WebEventRunSearch
  • 3008

    EnumServletEvents.WebEventArgumentFolderType

    openSecuritySetup
    Event for opening 'Security setup' page.

    3049

    EnumServletEvents.WebEventOpenSecuritySetup

    openShared
    Event for opening 'Shared Reports' page.

    3002

    EnumServletEvents.WebEventOpenSharedReports

    openSubscriptionEngineSetup
    Event for opening 'Subscriptions Engine setup' page.

    3050

    EnumServletEvents.WebEventOpenSubscriptionEngineSetup

    openSummary
    Event for opening the 'Summary' page.

    3059

    EnumServletEvents.WebEventOpenSummary

    openTopLevelUserGroups
    Event for opening the top level user groups.

    3112

    EnumServletEvents.WebEventOpenTopLevelUserGroups

    openWizard
    Event for opening 'Wizard' page.

    3101

    EnumServletEvents.WebEventOpenWizard

    pdfDisplay
    Event for exporting PDF data back to the client.

    3014

    EnumServletEvents.WebEventPDFDisplay

    PDFAdminFooterFile

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

    EnumServletEvents.WebEventArgumentPDFAdminFooterFile

    PDFAdminHeaderFile

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

    EnumServletEvents.WebEventArgumentPDFAdminHeaderFile

    PDFCoverPageFilterDetails

    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:
  • EnumServletEvents.WebEventOpenPrint
  • 3105

    EnumServletEvents.WebEventArgumentPDFCoverPageFilterDetails

    PDFExpandPageByFields

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

    EnumServletEvents.WebEventArgumentPDFExpandPageByFields

    PDFExportSection

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

    EnumServletEvents.WebEventArgumentPDFExportSection

    PDFFitToPagesTall

    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 EnumServletEvents.WebEventArgumentPDFScalingOption is set to PrintBean.SCALING_FIT_TO_PAGE_OPTION.
    Used in following event:
  • EnumServletEvents.WebEventPDFDisplay
  • 3104

    EnumServletEvents.WebEventArgumentPDFFitToPagesTall

    PDFFitToPagesWide

    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 EnumServletEvents.WebEventArgumentPDFScalingOption is set to PrintBean.SCALING_FIT_TO_PAGE_OPTION.
    Used in following event:
  • EnumServletEvents.WebEventPDFDisplay
  • 3103

    EnumServletEvents.WebEventArgumentPDFFitToPagesWide

    PDFFooterCenterSection

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

    EnumServletEvents.WebEventArgumentPDFFooterCenterSection

    PDFFooterLeftSection

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

    EnumServletEvents.WebEventArgumentPDFFooterLeftSection

    PDFFooterRightSection

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

    EnumServletEvents.WebEventArgumentPDFFooterRightSection

    PDFHeaderCenterSection

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

    EnumServletEvents.WebEventArgumentPDFHeaderCenterSection

    PDFHeaderLeftSection

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

    EnumServletEvents.WebEventArgumentPDFHeaderLeftSection

    PDFHeaderRightSection

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

    EnumServletEvents.WebEventArgumentPDFHeaderRightSection

    PDFMarginSizeBottom

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

    EnumServletEvents.WebEventArgumentPDFMarginSizeBottom

    PDFMarginSizeLeft

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

    EnumServletEvents.WebEventArgumentPDFMarginSizeLeft

    PDFMarginSizeRight

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

    EnumServletEvents.WebEventArgumentPDFMarginSizeRight

    PDFMarginSizeTop

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

    EnumServletEvents.WebEventArgumentPDFMarginSizeTop

    PDFMaxCells

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

    EnumServletEvents.WebEventArgumentPDFMaxCells

    PDFMaxFooterSize

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

    EnumServletEvents.WebEventArgumentPDFMaxFooterSize

    PDFMaxHeaderSize

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

    EnumServletEvents.WebEventArgumentPDFMaxHeaderSize

    PDFOutlineModeState

    Argument to specify the Outline Mode state. Used in following event:
  • EnumServletEvents.WebEventPDFDisplay
  • 3114

    EnumServletEvents.WebEventArgumentPDFOutlineModeState

    PDFPaperOrientationOption

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

    EnumServletEvents.WebEventArgumentPDFPaperOrientationOption

    PDFPaperSize

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

    EnumServletEvents.WebEventArgumentPDFPaperSize

    PDFScalingOption

    Used in following event:
  • EnumServletEvents.WebEventOpenAdminFAQs
  • EnumServletEvents.WebEventOpenAdminHelp
  • EnumServletEvents.WebEventOpenAdminHelpIndex
  • 3102

    EnumServletEvents.WebEventArgumentIsAdminHelp

    PDFShowOptions

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

    EnumServletEvents.WebEventArgumentPDFShowOptions

    PDFShrinkFontPercentage

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

    EnumServletEvents.WebEventArgumentPDFShrinkFontPercentage

    savePreferences

    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:
  • EnumServletEvents.WebEventOpenExport
  • 3028

    EnumServletEvents.WebEventArgumentNotAskExportOptions

    quickLogout
    Event for performing a quick logout.

    3019

    EnumServletEvents.WebEventQuickLogout

    reportFlashExport
    Export report to Flash

    3136

    EnumServletEvents.WebEventReportFlashExport

    returnTo
    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.

    3025

    EnumServletEvents.WebEventReturnTo

    runDocument
    Specifies an event to execute a Document. The possible parameters that can be sent in are

    32001

    EnumDocumentBeanEvents.DOCUMENT_EVENT_EXECUTE_DOCUMENT

    documentID

    objectID -- argument using for browsing objects.

    1001

    EnumObjectBeanEvents.OBJECT_EVENT_ARGUMENT_OBJECT_ID

    documentName

    objectName

    1004

    EnumObjectBeanEvents.OBJECT_EVENT_ARGUMENT_OBJECT_NAME

    elementsPromptAnswers

    Specifies an argument for the new prompt answer for WebElementsPrompt in document drilling.

    32339

    EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

    executionFlags

    Specifies an argument for the object id of a Document.

    32201

    EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_EXECUTION_FLAGS

    linkAnswers

    32351

    EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_LINK_ANSWERS

    messageID

    Specifies an argument for the message id of a Document instance.

    32202

    EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_MESSAGE_ID

    originMessageID

    Specifies an argument for the original document message id in document drilling.

    32337

    EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

    promptsAnswerXML

    Specifies an argument for the original document's prompt answer XML in document drilling.

    32338

    EnumDocumentBeanEvents.DOCUMENT_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

    runReport
    Event for executing a report. This sets the reportID or the messageID/stateID and the execution, result and display flags. Note that settings the maxWait value indirectly controls the async parameter If the value of maxWait is set to 0, it is considered asynchronous execution WebResultSetInstance.setAsync(boolean)

    4001

    EnumReportBeanEvents.REPORT_EVENT_EXECUTE

    cubeID

    Specifies the DSSID of the cube report

    4225

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_CUBE_ID

    dispFlags

    SaveAs display flags.

    4004

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DISPLAY_FLAGS

    doNotUpdateCaches

    4240

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DO_NOT_UPDATE_CACHES

    duplicateMessage

    Specifies whether to duplicate the message passed.

    4171

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_EXECUTION_DUPLICATE_MESSAGE_ID

    elementsPromptAnswers

    Specifies an argument for the new prompt answer for WebElementsPrompt in document drilling.

    4189

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

    execFlags

    flags to be used while performing report execution.

    4002

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_EXECUTION_FLAGS

    graphHeigth

    height of the graph.

    4080

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_HEIGHT

    graphWidth

    width of the graph.

    4081

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_WIDTH

    linkAnswers

    4222

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_LINK_ANSWERS

    maxWait

    Specifies an argument for max wait in report execution.

    4190

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_MAX_WAIT

    messageID

    String argument specifying the message ID of the report.

    4117

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_EXECUTION_MESSAGE_ID

    objectsPromptAnswers

    Specifies an argument for the new prompt answer for WebObjectsPrompt in document drilling.

    4221

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_PLAIN_OBJECT_PROMPT_ANSWER

    originMessageID

    Specifies an argument for the original report message id in document drilling.

    4187

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

    promptAnswerMode

    An integer prompt answer mode from EnumWebPromptAnswerMode

    4232

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_PROMPT_ANSWER_MODE_OPTION

    promptsAnswerXML

    Specifies an argument for the original report's prompt answer XML in document drilling.

    4188

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

    promptStyle

    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.

    30051

    EnumServletEvents.WebEventArgumentPromptStyle

    reportID

    objectID -- argument using for browsing objects.

    1001

    EnumObjectBeanEvents.OBJECT_EVENT_ARGUMENT_OBJECT_ID

    reportName

    objectName

    1004

    EnumObjectBeanEvents.OBJECT_EVENT_ARGUMENT_OBJECT_NAME

    reportSubtype

    1005

    EnumObjectBeanEvents.OBJECT_EVENT_ARGUMENT_OBJECT_SUBTYPE

    reportViewMode

    integer argument of EnumWebReportViewMode specifying the report view mode.

    4115

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_VIEW_MODE

    resultFlags

    result flags.

    4003

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_RESULT_FLAGS

    saveFlags

    save as flags.

    4005

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SAVE_AS_FLAGS

    srcAnswers

    4234

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SRC_ANSWERS

    stateID

    state ID of the report.

    4118

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_EXECUTION_STATE_ID

    valuePromptAnswers

    Specifies an argument for the new prompt answer for WebConstantPrompt in document drilling.

    4220

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER

    visMode

    Visualization mode.

    4231

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_VISUALIZATION_MODE

    xdaID

    Specifies the DSSID of the xda report

    4219

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_XDA_ID

    runReport

    40011

    EnumReportFrameEvents.WebEventChangeOptimizedMode

    dispFlags

    Save-as display flags.

    4004

    EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_DISPLAY_FLAGS

    duplicateMessage

    Specifies whether to duplicate the message passed.

    4171

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_EXECUTION_DUPLICATE_MESSAGE_ID

    elementsPromptAnswers

    Specifies an argument for the new prompt answer for WebElementsPrompt in document drilling.

    4189

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

    execFlags

    flags to be used while performing report execution.

    4002

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_EXECUTION_FLAGS

    graphHeight

    Height of the graph.

    4080

    EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRAPHPROPS_HEIGHT

    graphWidth

    Width of the graph.

    4081

    EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRAPHPROPS_WIDTH

    linkAnswers

    4222

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_LINK_ANSWERS

    messageID

    String argument specifying the message ID of the report.

    4117

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_EXECUTION_MESSAGE_ID

    originMessageID

    Specifies an argument for the original report message id in document drilling.

    4187

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

    promptAnswerMode

    4232

    EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_GRIDPROPS_BORDER_3D_RIGHT_COLOR

    promptsAnswerXML

    Specifies an argument for the original report's prompt answer XML in document drilling.

    4188

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

    promptStyle

    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.

    30051

    EnumServletEvents.WebEventArgumentPromptStyle

    reportID

    1001

    EnumAttributeBeanEvents.ATTRIBUTE_EVENT_ARGUMENT_ATTRIBUTE_ID

    reportName

    Specifies an argument for report name.

    1004

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_REPORT_NAME

    reportViewMode

    View mode (see EnumWebReportViewMode).

    4115

    EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_VIEW_MODE

    resultFlags

    result flags.

    4003

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_RESULT_FLAGS

    saveFlags

    Save-as flags.

    4005

    EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_SAVE_AS_FLAGS

    stateID

    State ID of the view.

    4118

    EnumViewBeanEvents.VIEW_EVENT_ARGUMENT_EXECUTION_STATE_ID

    valuePromptAnswers

    Specifies an argument for the new prompt answer for WebConstantPrompt in document drilling.

    4220

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER

    visMode

    Visualization mode.

    4231

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_VISUALIZATION_MODE

    runTemplateFilter
    Sets the flags for execution based on templateID and filterID.

    4033

    EnumReportBeanEvents.REPORT_EVENT_EXECUTE_TEMPLATE_FILTER

    dispFlags

    SaveAs display flags.

    4004

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DISPLAY_FLAGS

    elementsPromptAnswers

    Specifies an argument for the new prompt answer for WebElementsPrompt in document drilling.

    4189

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

    execFlags

    flags to be used while performing report execution.

    4002

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_EXECUTION_FLAGS

    filterID

    String argument specifying the filterID.

    4120

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_EXECUTION_FILTER_ID

    originMessageID

    Specifies an argument for the original report message id in document drilling.

    4187

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

    promptsAnswerXML

    Specifies an argument for the original report's prompt answer XML in document drilling.

    4188

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

    promptStyle

    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.

    30051

    EnumServletEvents.WebEventArgumentPromptStyle

    resultFlags

    result flags.

    4003

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_RESULT_FLAGS

    saveFlags

    save as flags.

    4005

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SAVE_AS_FLAGS

    templateID

    String argument specifying the templateID.

    4119

    EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_EXECUTION_TEMPLATE_ID

    rwDetails
    Event for getting the report writing document details.

    3105

    EnumServletEvents.WebEventGetRWDocumentDetails

    allowExecute

    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:
  • EnumServletEvents.WebEventArgumentAllowExecute
    Usage:
  • '0' : don't allow execution.
  • '1' : allow execution.
  • 3016

    EnumServletEvents.WebEventArgumentAllowExecute

    executionMode

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

    3115

    EnumServletEvents.WebEventArgumentRWExecutionMode

    messageID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • 3010

    EnumServletEvents.WebEventArgumentMessageID

    rwID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

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

    3130

    EnumServletEvents.WebEventRWDHTMLExport

    documentID

    Object ID.

    2048001

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_OBJECT_ID

    documentName

    Object name.

    2048020

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_OBJECT_NAME

    elementsPromptAnswers

    Specifies element prompts' answers in a URL friendly format.

    2048089

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

    execFlags

    Execution flags

    2048003

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXEC_FLAGS

    executionMode

    Execution mode (see EnumRWExecutionModes).

    2048092

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXECUTION_MODE

    freshExec

    Argument indicating whether the RW document to be executed with fresh-execution related execution flags.

    2048060

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_REEXECUTE_FRESH

    maxWait

    Max time in milliseconds to wait for event execution. A value of -1 means wait indefinitely.

    2048093

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_MAX_WAIT

    messageID

    Message ID.

    2048002

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_MESSAGE_ID

    originMessageID

    Specifies the message ID of the original Document (HTML or RW) whose prompt answers are going to be retrieved.

    2048087

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

    pollingFreq

    Polling frequency.

    2048094

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_POLLING_FREQUENCY

    promptAnswerMode

    An integer prompt answer mode from EnumWebPromptAnswerMode

    2048201

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PROMPT_ANSWER_MODE_OPTION

    promptsAnswerXML

    Specifies the prompt answer XML from the original Document (HTML or RW).

    2048088

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

    useDefAns

    Whether to use default prompt answers.

    2048103

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_USE_DEFAULT_PROMPT_ANSWERS

    valuePromptAnswers

    Specifies an argument for the new prompt answer for WebConstantPrompt in document drilling.

    2048132

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER

    rwExport
    Event for exporting RWD data back to the client.

    3103

    EnumServletEvents.WebEventRWExport

    executionMode

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

    3115

    EnumServletEvents.WebEventArgumentRWExecutionMode

    gridKey

    Section key.

    2048007

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_SECTION_KEY

    messageID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • 3010

    EnumServletEvents.WebEventArgumentMessageID

    rwExportMode

    Argument to specify the export mode. Used in following event:
  • EnumServletEvents.WebEventRWExport
  • 3116

    EnumServletEvents.WebEventArgumentRWExportMode

    rwID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    sliceId

    3152

    EnumServletEvents.WebEventArgumentSliceId

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

    3069

    EnumServletEvents.WebEventReportWritingDocumentPDFFastExport

    documentID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    documentName

    Object name.

    2048020

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_OBJECT_NAME

    elementsPromptAnswers

    Specifies element prompts' answers in a URL friendly format.

    2048089

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

    enableFooter

    2048305

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPORT_PDF_FOOTER

    enableHeader

    2048304

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPORT_PDF_HEADER

    executionFlags

    Execution flags

    2048003

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXEC_FLAGS

    executionMode

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

    3115

    EnumServletEvents.WebEventArgumentRWExecutionMode

    freshExec

    Argument indicating whether the RW document to be executed with fresh-execution related execution flags.

    2048060

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_REEXECUTE_FRESH

    htmlDelayTime

    2048307

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPORT_PDF_HTMLCONTAINER_DELAY_TIME

    maxWait

    Max time in milliseconds to wait for event execution. A value of -1 means wait indefinitely.

    2048093

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_MAX_WAIT

    messageID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventGridDrillFromDocToReport
  • 3010

    EnumServletEvents.WebEventArgumentMessageID

    mode

    Specifies the export mode. Should be a value from EnumRWExportModes

    2048095

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPORT_MODE

    originMessageID

    Specifies the message ID of the original Document (HTML or RW) whose prompt answers are going to be retrieved.

    2048087

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

    overviewViz

    2048306

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPORT_PDF_OVERVIEW

    pageOrientation

    2048303

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPORT_PDF_PAGEORIENTATION

    paperHeight

    2048301

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPORT_PDF_PAPERHEIGHT

    paperWidth

    2048302

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPORT_PDF_PAPERWIDTH

    pdfPwd

    2048308

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPORT_PDF_PASSWORD

    pollingFreq

    Polling frequency.

    2048094

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_POLLING_FREQUENCY

    promptAnswerMode

    An integer prompt answer mode from EnumWebPromptAnswerMode

    2048201

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PROMPT_ANSWER_MODE_OPTION

    promptsAnswerXML

    Specifies the prompt answer XML from the original Document (HTML or RW).

    2048088

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

    range

    2048159

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_EXPORT_RANGE

    subscriptionID

    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:
  • EnumServletEvents.WebEventReportWritingDocumentPDFFastExport
  • 3107

    EnumServletEvents.WebEventArgumentSubscriptionID

    triggerID

    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:
  • EnumServletEvents.WebEventEditSubscription
  • 3029

    EnumServletEvents.WebEventArgumentTriggerID

    useDefAns

    Whether to use default prompt answers.

    2048103

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_USE_DEFAULT_PROMPT_ANSWERS

    valuePromptAnswers

    Specifies an argument for the new prompt answer for WebConstantPrompt in document drilling.

    2048132

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER

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

    3070

    EnumServletEvents.WebEventReportWritingDocumentPDFExport

    savePassword

    3009

    target

    3004

    schedule
    Event to Open Schedule page.

    3170

    EnumServletEvents.WebEventOpenSchedule

    search
    Event for performing any search.

    3016

    EnumServletEvents.WebEventRunSearch

    folderId

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    folderName

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

    3167

    EnumServletEvents.WebEventArgumentFolderName

    folderType

    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:
  • EnumServletEvents.WebEventRunSearch
  • 3008

    EnumServletEvents.WebEventArgumentFolderType

    objType

    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:
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • 3007

    EnumServletEvents.WebEventArgumentObjectType

    srchStr

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

    EnumServletEvents.WebEventArgumentSearchString

    selectFilter
    Event to select a filter for template/filter execution.

    3044

    EnumServletEvents.WebEventSelectFilter

    filterID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    folderID

    Specifies the object ID of a WebFolder.

    1001

    EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_FOLDER_ID

    systemFolder

    Specifies the system folder to browse into.

    2023

    EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_SYS_FOLDER

    selectTemplate
    Event to select a template for template/filter execution.

    3043

    EnumServletEvents.WebEventSelectTemplate

    folderID

    Specifies the object ID of a WebFolder.

    1001

    EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_FOLDER_ID

    systemFolder

    Specifies the system folder to browse into.

    2023

    EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_SYS_FOLDER

    templateID

    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:
  • EnumServletEvents.WebEventEditReport
  • EnumServletEvents.WebEventDeleteObject
  • EnumServletEvents.WebEventRunSearch
  • EnumServletEvents.WebEventSelectTemplate
  • EnumServletEvents.WebEventSelectFilter
  • EnumServletEvents.WebEventOpenObjectSubscriptions
  • EnumServletEvents.WebEventEditSubscription
  • EnumServletEvents.WebEventAddSubscription
  • EnumServletEvents.WebEventNCEditSubscription
  • EnumServletEvents.WebEventNCAddSubscription
  • EnumServletEvents.WebEventNCSendNow
  • EnumTemplateFilterExecEvents.WebEventSetFilterId
  • EnumTemplateFilterExecEvents.WebEventSetTemplateId
  • 3001

    EnumServletEvents.WebEventArgumentObjectID

    showSecRoles

    3120

    EnumServletEvents.WebEventOpenSecurityRolesFolder

    WebArchitectEntryPage

    3176

    EnumServletEvents.WebEventOpenArchitect


    Notes

    * denotes required field.