Supported Bean: ServletWebComponent
Event handler: com.microstrategy.web.app.beans.EnumSysBeanTypes.AppBeanServlet (3)
Events
addSubscription | ||||
Event to open a page for adding a subscription. |
3034 | |||
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 | ||
elementsPromptAnswers | Plain element prompt answer. |
5120012 |
EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER |
|
messageID | Argument specifying the message ID. |
512001 | ||
mobile |
5120016 | |||
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 | ||
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 | ||
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 | ||
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 | ||
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 | ||
browseFolder | ||||
event for browsing a given folder. |
2001 | |||
folderID | objectID -- argument using for browsing objects. |
1001 | ||
folderName | objectName |
1004 | ||
systemFolder | Specifies the system folder to browse into. |
2023 | ||
browseUserGroup | ||||
event for browsing a given object. |
1001 | |||
*groupID | objectID -- argument using for browsing objects. |
1001 | ||
objectFlag | flags -- integer argument specifying the flags (from EnumDSSXMLObjectFlags ) to be used while performing
object browse operations. |
1003 | ||
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 | |||
close | ||||
Event for closing dashboard page |
3198 | |||
colorPalette | ||||
Event to open the page to edit color palettes |
3188 | |||
createHTML5VI | ||||
Event to handle creating New Analysis Document in HTML5 VI page. |
3185 | |||
executionMode | Argument to specify the Execution mode.
Its value comes from EnumRWExecutionModes |
3115 | ||
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 | ||
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 | ||
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 | ||
parentFolderId |
3185 | |||
rwCreateFlags |
3163 | |||
createPrompt | ||||
3118 | ||||
folderId |
3135 | |||
promptExpressionType |
3139 | |||
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 | ||
createSecRole | ||||
3122 | ||||
createUser | ||||
Event for creating a user. |
3116 | |||
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 | ||
createUserGroup | ||||
Event for creating a user group. |
3117 | |||
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 | ||
dashboardPublishWizard | ||||
3138 | ||||
delete | ||||
Event for deleting an object. |
3015 | |||
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 | ||
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 | ||
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 | ||
deleteHistoryList | ||||
Event for clearing history list. |
3024 | |||
displayError | ||||
3193 | ||||
message |
3184 | |||
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 | ||
nodeKey | Specifies node key of the grid object for filter on selections from doc to report
Used in following event:
EnumServletEvents.WebEventDrillToFixedTemplateFromDocToReport |
3149 | ||
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 | ||
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 | ||
sliceId |
3152 | |||
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 | ||
editPrompt | ||||
3119 | ||||
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 | ||
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 | ||
editReport | ||||
Event for editing a report. |
3005 | |||
cubeID |
3136 | |||
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 | ||
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 | ||
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 | ||
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 | ||
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 | ||
srcID |
3155 | |||
srcType |
3138 | |||
editRW | ||||
Event for exporting RWD PDF data back to the client. |
3104 | |||
convertFromVI | Flag indicating we are performing a conversion from VI Dashboard to RS Document |
3182 | ||
executionMode | Argument to specify the Execution mode.
Its value comes from EnumRWExecutionModes |
3115 | ||
importAfterSave |
3177 | |||
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 | ||
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 | ||
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 | ||
rptStateID |
2048143 | |||
rwCreateFlags |
3163 | |||
rwCreateTemplateID |
3164 | |||
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 | ||
rwViewMode |
3158 | |||
editSecRole | ||||
Event for editing a security role. |
3121 | |||
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 | ||
editSubscription | ||||
Event to open a page for editing a subscription. |
3033 | |||
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 | ||
elementsPromptAnswers | Plain element prompt answer. |
5120012 |
EnumScheduleBeanEvents.SCHEDULE_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER |
|
messageID | Argument specifying the message ID. |
512001 | ||
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 | ||
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 | ||
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 | ||
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 | ||
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 | ||
editUser | ||||
Event for editing a user. |
3114 | |||
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 | ||
editUserGroup | ||||
Event for editing a user group. |
3115 | |||
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 | ||
executeHTML5VI | ||||
3140 | ||||
currentViewMedia | Media type |
2048174 | ||
documentID | Object ID. |
2048001 | ||
documentName | Object name. |
2048020 | ||
elementsPromptAnswers | Specifies element prompts' answers in a URL friendly format. |
2048089 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER |
|
execFlags | Execution flags |
2048003 | ||
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 | ||
layoutKey | Argument used to select the layout by key to be shown when a dashboard or document is executed |
2048299 | ||
linkAnswers |
2048140 | |||
maxWait | Max time in milliseconds to wait for event execution. A value of -1 means wait indefinitely. |
2048093 | ||
messageID | Message ID. |
2048002 | ||
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 | ||
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 | ||
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 | ||
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 | ||
srcAnswers |
2048215 | |||
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 | ||||
currentViewMedia | Media type |
2048174 | ||
documentID | Object ID. |
2048001 | ||
documentName | Object name. |
2048020 | ||
elementsPromptAnswers | Specifies element prompts' answers in a URL friendly format. |
2048089 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER |
|
execFlags | Execution flags |
2048003 | ||
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 | |||
maxWait | Max time in milliseconds to wait for event execution. A value of -1 means wait indefinitely. |
2048093 | ||
messageID | Message ID. |
2048002 | ||
objType | Object type (see EnumDSSXMLObjectTypes ). |
2048009 | ||
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 | ||
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 | |||
currentViewMedia | Media type |
2048174 | ||
documentID | Object ID. |
2048001 | ||
documentName | Object name. |
2048020 | ||
elementsPromptAnswers | Specifies element prompts' answers in a URL friendly format. |
2048089 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER |
|
execFlags | Execution flags |
2048003 | ||
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 | |||
linkAnswers |
2048140 | |||
maxWait | Max time in milliseconds to wait for event execution. A value of -1 means wait indefinitely. |
2048093 | ||
messageID | Message ID. |
2048002 | ||
objType | Object type (see EnumDSSXMLObjectTypes ). |
2048009 | ||
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 | ||
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:
|
2048001 | |||
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 | ||
deltaXml | An string present the manipulator deltaXml |
2048202 | ||
documentID | Object ID. |
2048001 | ||
documentName | Object name. |
2048020 | ||
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 | ||
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 | |||
linkAnswers |
2048140 | |||
maxWait | Max time in milliseconds to wait for event execution. A value of -1 means wait indefinitely. |
2048093 | ||
messageID | Message ID. |
2048002 | ||
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 | ||
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 | ||
rptStateID | Control source object ID |
2048114 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_CONTROL_SOURCE_ID |
|
rptStateID |
2048143 | |||
rptViewMode | View mode
(see EnumWebReportViewMode ). |
4115 | ||
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 | ||
srcAnswers |
2048215 | |||
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 | |||
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 | ||
documentName | objectName |
1004 | ||
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 | ||
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 | |||
defaultRunMode |
3157 | |||
dispFlags | SaveAs display flags. |
4004 | ||
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 | ||
graphHeigth | height of the graph. |
4080 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_HEIGHT |
|
graphWidth | width of the graph. |
4081 | ||
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 | ||
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 | ||
reportName | objectName |
1004 | ||
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 | ||
resultFlags | result flags. |
4003 | ||
saveFlags | save as flags. |
4005 | ||
showOptionsPage | Whether to show the export options page when exporting. Note: Used for customizations only. Used in following event: EnumServletEvents.WebEventFastExport |
3161 | ||
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 | |||
dispFlags | SaveAs display flags. |
4004 | ||
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 | ||
graphHeigth | height of the graph. |
4080 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_HEIGHT |
|
graphWidth | width of the graph. |
4081 | ||
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 | ||
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 | ||
reportName | objectName |
1004 | ||
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 | ||
resultFlags | result flags. |
4003 | ||
saveFlags | save as flags. |
4005 | ||
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 | |||
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 | ||
documentName | Object name. |
2048020 | ||
elementsPromptAnswers | Specifies element prompts' answers in a URL friendly format. |
2048089 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER |
|
executionFlags | Execution flags |
2048003 | ||
executionMode | Argument to specify the Execution mode.
Its value comes from EnumRWExecutionModes |
3115 | ||
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 | ||
maxWait | Max time in milliseconds to wait for event execution. A value of -1 means wait indefinitely. |
2048093 | ||
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 | ||
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 | |||
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 | ||
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 | ||
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 | |||
getChangePwd | ||||
Event for changing user's password. |
3042 | |||
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 | ||
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 | ||
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 | ||
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 | ||
getDocumentDetails | ||||
Event for getting the document details. |
3020 | |||
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: |
3016 | ||
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 | ||
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 | ||
viewMode | Argument to specify the document view mode.
Value expected comes from the EnumWebDocumentViewMode enumeration
Used in following event:
EnumServletEvents.WebEventReportWritingDocumentPDFFastExport |
3106 | ||
getReportDetails | ||||
Event for getting the report details. |
3021 | |||
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: |
3016 | ||
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 | ||
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 | ||
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 | ||
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 | ||
graphDrillFromDocumentToReport | ||||
Event for graph drilling from a document to a report. |
3126 | |||
3126.x | Specifies the X pixel offset for graph drill
Used in following event:
EnumServletEvents.WebEventGraphDrillFromDocToReport |
3147 | ||
3126.y | Specifies the Y pixel offset for graph drill
Used in following event:
EnumServletEvents.WebEventGraphDrillFromDocToReport |
3148 | ||
displayMode | Specifies the display mode. A value from the enumeration EnumDSSXMLDisplayMode
Used in following event:
EnumServletEvents.WebEventGraphDrillFromDocToReport |
3146 | ||
drillPathKey | Argument to specify drill path key. Used in following event: EnumServletEvents.WebEventGridDrillFromDocToReport EnumServletEvents.WebEventGraphDrillFromDocToReport |
3141 | ||
graphHeight | Argument to specify the height of a report graph. String value for representing an int value. Used by following event: EnumServletEvents.WebEventLoadGraph |
3111 | ||
graphWidth | Argument to specify the with of a report graph. String value for representing an int value. Used by following event: EnumServletEvents.WebEventLoadGraph |
3110 | ||
retainParent | Specifies whether the parent should be kept after performing the drill operation.
Used in following event:
EnumServletEvents.WebEventGridDrillFromDocToReport EnumServletEvents.WebEventGraphDrillFromDocToReport |
3142 | ||
retainThresh | specifies whether the thresholds should be kept after performing the drill operation.
Used in following event:
EnumServletEvents.WebEventGridDrillFromDocToReport EnumServletEvents.WebEventGraphDrillFromDocToReport |
3144 | ||
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 | ||
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 | ||
sliceId |
3152 | |||
gridDrillFromDocumentToReport | ||||
Event for grid drilling from a document to a report. |
3125 | |||
displayMode | Specifies the display mode. A value from the enumeration EnumDSSXMLDisplayMode
Used in following event:
EnumServletEvents.WebEventGraphDrillFromDocToReport |
3146 | ||
drillPathKey | Argument to specify drill path key. Used in following event: EnumServletEvents.WebEventGridDrillFromDocToReport EnumServletEvents.WebEventGraphDrillFromDocToReport |
3141 | ||
elementList | Argument to specify element list to filter on while drilling. Used in following event: EnumServletEvents.WebEventGridDrillFromDocToReport |
3143 | ||
filterOnPageBy | Argument specifying whether to filter on the Page By axis during drilling.
Used in following event:
EnumServletEvents.WebEventGridDrillFromDocToReport |
3145 | ||
retainParent | Specifies whether the parent should be kept after performing the drill operation.
Used in following event:
EnumServletEvents.WebEventGridDrillFromDocToReport EnumServletEvents.WebEventGraphDrillFromDocToReport |
3142 | ||
retainThresh | specifies whether the thresholds should be kept after performing the drill operation.
Used in following event:
EnumServletEvents.WebEventGridDrillFromDocToReport EnumServletEvents.WebEventGraphDrillFromDocToReport |
3144 | ||
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 | ||
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 | ||
sliceId |
3152 | |||
htmlMenu | ||||
Event for handling menu selections when HTML mode is on. |
3027 | |||
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 | ||
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 | ||
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 | ||
inbox | ||||
Event for opening the 'History list' page. |
3018 | |||
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 | ||
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 | ||
initializeFromSchedule | ||||
Event for initializing the report bean using a schedule. |
4057 | |||
*triggerID | String argument indicating the trigger to be used. |
4127 | ||
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 | ||
reportViewMode | integer argument of EnumWebReportViewMode specifying the report view mode. |
4115 | ||
saveToInbox | Specifies whether to save the message to inbox. |
4172 | ||
targetID | Argument indicating the target object to be used to initialize the report bean using a schedule. |
4162 | ||
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 | ||
targetID | Target object ID for initializing a RW Bean with Schedule |
2048057 | ||
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 | ||
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 | ||
reportViewMode | integer argument of EnumWebReportViewMode specifying the report view mode. |
4115 | ||
saveToInbox | Specifies whether to save the message to inbox. |
4172 | ||
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 | |||
*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 | |||
graphHeight | Argument to specify the height of a report graph. String value for representing an int value. Used by following event: EnumServletEvents.WebEventLoadGraph |
3111 | ||
graphWidth | Argument to specify the with of a report graph. String value for representing an int value. Used by following event: EnumServletEvents.WebEventLoadGraph |
3110 | ||
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 | ||
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 | ||
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 | ||
requestId |
3137 | |||
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 | ||
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 | ||
logout | ||||
Event for logging out the application. |
3008 | |||
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 | ||
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 | ||
ncAddCacheSubscription | ||||
Event to add a cache subscription |
3196 | |||
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 | ||
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 | ||
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 | ||
ncAddFileSubscription | ||||
Event to open the page of Narrowcast Server print addresses. |
3074 | |||
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 | ||
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 | ||
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 | ||
ncAddFTPSubscription | ||||
Event to open the page of Narrowcast Server FTP addresses. |
3078 | |||
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 | ||
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 | ||
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 | ||
ncAddInboxSubscription | ||||
Event to add a subscription to the history list |
3128 | |||
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 | ||
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 | ||
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 | ||
ncAddMobileSubscription | ||||
Event to add a mobile subscription |
3134 | |||
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 | ||
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 | ||
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 | ||
ncAddPersonalViewSubscription | ||||
3174 | ||||
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 | ||
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 | ||
ncAddPrintSubscription | ||||
Event to open the page of Narrowcast Server print addresses. |
3076 | |||
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 | ||
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 | ||
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 | ||
ncAddresses | ||||
Event to open the page of Narrowcast Server email addresses. |
3038 | |||
ncAddSubscription | ||||
Event to open a page for adding a Narrowcast Server subscription. |
3036 | |||
_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 |
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 | ||
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 | ||
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 | ||
zip | Indicates whether the format should be zipped. |
256017 |
EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ZIP_CONTENTS |
|
ncEditCacheSubscription | ||||
Event to edit a cache subscription |
3197 | |||
_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 | ||
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 | |||
_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 | ||
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 | |||
_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 | ||
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 | |||
_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 | ||
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 | |||
_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 | ||
editMode | Denotes the edit mode. Should be a value from EnumWebSubscriptionEditModes |
256012 |
EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EDIT_MODE |
|
ncEditPersonalViewSubscription | ||||
3173 | ||||
_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 | ||
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 | |||
_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 | ||
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 | |||
_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 | ||
addressID | Argument specifying the address ID.
As of MicroStrategy Web 8.0.1, setting this argument will
clear all other addresses in |
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 | |||
ncFTPAddresses | ||||
Event to open the page of Narrowcast Server FTP addresses. |
3079 | |||
ncPrintAddresses | ||||
Event to open the page of Narrowcast Server print addresses. |
3072 | |||
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 | |||
_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 |
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 | ||
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 | ||
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 | ||
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 | |||
ncSubsConfirm | ||||
Event for showing confirmation page for NCS email, file opr print subscriptions. |
3107 | |||
open | ||||
Event for opening any page in application. The name of the page is part of the argument's list. |
3004 | |||
clear |
3162 | |||
fromPageHistory | Indicates that the page is opened from the page history (back/forward buttons) |
3173 | ||
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 | ||
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 | ||
openAbout | ||||
Event for opening 'About' page. |
3048 | |||
openAdminFAQs | ||||
Event for opening the Administrator frequently asked questions page. |
3064 | |||
isAdminHelp | Used in following event:
EnumServletEvents.WebEventOpenAdminFAQs EnumServletEvents.WebEventOpenAdminHelp EnumServletEvents.WebEventOpenAdminHelpIndex |
3102 | ||
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 | ||
openAdminHelp | ||||
Event for opening the Administrator online help page. |
3065 | |||
isAdminHelp | Used in following event:
EnumServletEvents.WebEventOpenAdminFAQs EnumServletEvents.WebEventOpenAdminHelp EnumServletEvents.WebEventOpenAdminHelpIndex |
3102 | ||
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 | ||
openAdminHelpIndex | ||||
Event for opening the Administrator online help index. |
3066 | |||
isAdminHelp | Used in following event:
EnumServletEvents.WebEventOpenAdminFAQs EnumServletEvents.WebEventOpenAdminHelp EnumServletEvents.WebEventOpenAdminHelpIndex |
3102 | ||
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 | ||
openAdminHome | ||||
Event for opening 'Home' page for given Web Administration section. |
3055 | |||
showDefault | Used in following event:
EnumServletEvents.WebEventAdminOpenHome |
3099 | ||
showServerProps | Used in following event:
EnumServletEvents.WebEventAdminOpenHome |
3100 | ||
openAdminHome | ||||
Event to save the PDF properties. Called right before exporting to PDF to save the PDF web properties on the Report Instance. |
3057 | |||
showDefault | Used in following event:
EnumServletEvents.WebEventAdminOpenHome |
3099 | ||
showServerProps | Used in following event:
EnumServletEvents.WebEventAdminOpenHome |
3100 | ||
openAnalysis | ||||
3169 |
|
|||
documentID |
3001 |
|
||
executionMode |
3115 |
|
||
messageID |
3010 |
|
||
objectType |
3007 |
|
||
rwDesignMode |
3017 |
|
||
rwViewMode |
3158 |
|
||
openAppSchemaPage | ||||
Event for opening Application Schema page |
3199 | |||
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 | ||
openCreate | ||||
Event for opening 'Create Reports' folder. |
3011 | |||
folderID | Specifies the object ID of a WebFolder . |
1001 | ||
parentFolderId |
3185 | |||
systemFolder | Specifies the system folder to browse into. |
2023 | ||
openCreateDocument | ||||
Event for opening 'Create Document' page. |
3100 | |||
folderID | Specifies the object ID of a WebFolder . |
1001 | ||
parentFolderId |
3185 | |||
systemFolder | Specifies the system folder to browse into. |
2023 | ||
openCreatePrompt | ||||
3123 | ||||
openDefaultDesktop | ||||
Event for opening the 'Default Desktop' page. |
3060 | |||
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: |
3024 | ||
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 | ||
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 | ||
openDefaultHome | ||||
Event to force open default home page independent of user preference. |
3192 | |||
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: |
3024 | ||
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 | ||
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 | ||
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 | ||
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 | ||
openDeleteAddress | ||||
Event for opening the 'Delete an address' page. |
3061 | |||
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 | ||
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 | ||
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 | |||
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 | ||
FbToken | Argument to specify the Facebook access token when logging in. Used by following event: EnumServletEvents.WebEventProcessLogin |
3166 | ||
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 | ||
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 | ||
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 | ||
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 | ||
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 | ||
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 | ||
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 | ||
tsvc | Argument for the two step verification code used during login. |
3183 | ||
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 | ||
openDesktop | ||||
Event for opening 'Desktop' page. |
3010 | |||
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: |
3024 | ||
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 | ||
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 | ||
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 | ||
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 | ||
openDiagnostics | ||||
Event for opening the 'Diagnostics configuration' page. |
3051 | |||
show | Used in following event:
EnumServletEvents.WebEventOpenDiagnostics |
3098 | ||
openDRL | ||||
Event to open the page of Dynamic addresse list in preference setting. |
3168 | |||
openExport | ||||
Event for opening 'Export' page. |
3012 | |||
defaultRunMode |
3157 | |||
exportExpandPageByFields | Argument to specify whether to expand the page by fields when exporting to Excel with formatting.
Used in following event:
EnumServletEvents.WebEventOpenExport |
3129 | ||
exportFilterDetails | Argument to specify whether to export the filter details. Used in following event: EnumServletEvents.WebEventOpenExport |
3124 | ||
exportFormatGraphs | Argument to specify the export format name for graphs.
Used in following event:
EnumServletEvents.WebEventOpenExport |
3120 | ||
exportFormatGrids | Argument to specify the export format name for grids.
Used in following event:
EnumServletEvents.WebEventOpenExport |
3119 | ||
exportHeadersAsText | Argument to specify whether to export the headers as text when exporting to Excel.
Used in following event:
EnumServletEvents.WebEventOpenExport |
3123 | ||
exportMetricValuesAsText | Argument to specify whether to export the metric values as text when exporting to Excel.
Used in following event:
EnumServletEvents.WebEventOpenExport |
3122 | ||
exportOverlapGridTitles | Argument to specify whether to overlap grid titles when exporting to Excel with formatting.
Used in following event:
EnumServletEvents.WebEventOpenExport |
3132 | ||
exportPlaintextDelimiter | Argument to specify the text delimiter for exporting to Plaintext.
Used in following event:
EnumServletEvents.WebEventOpenExport |
3121 | ||
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 | ||
exportSection | Argument to specify what section to export.
A value from EnumExportSection .
Used in following event:
EnumServletEvents.WebEventOpenExport |
3118 | ||
exportUseLiveChartGraphs | Argument to specify whether to use live chart for graphs when exporting to Excel with formatting.
Used in following event:
EnumServletEvents.WebEventOpenExport |
3131 | ||
exportUseSeparateSheets | Argument to specify whether to use separate pages when exporting to Excel with formatting.
Used in following event:
EnumServletEvents.WebEventOpenExport |
3130 | ||
PDFOutlineModeState | Argument to specify the Outline Mode state.
Used in following event:
EnumServletEvents.WebEventPDFDisplay |
3114 | ||
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 | ||
openExportDocument | ||||
Event for opening the 'Export document' page. |
3023 | |||
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 | ||
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 | ||
openExportOptions | ||||
Event for opening the 'Export options' page. |
3022 | |||
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 | ||
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 | ||
openExportOptionsFromReport | ||||
Event for opening the export options page |
3068 | |||
defaultRunMode |
3157 | |||
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 | ||
PDFOutlineModeState | Argument to specify the Outline Mode state.
Used in following event:
EnumServletEvents.WebEventPDFDisplay |
3114 | ||
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 | ||
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 | ||
showOptionsPage | Whether to show the export options page when exporting. Note: Used for customizations only. Used in following event: EnumServletEvents.WebEventFastExport |
3161 | ||
openExportSaveReportProperties | ||||
Event for opening the ExportSaveReportProperties page. |
3111 | |||
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 | ||
openFAQs | ||||
Event for opening 'FAQs' page. |
3045 | |||
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 | ||
openFilterEditor | ||||
3113 | ||||
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 | ||
folderId |
3135 | |||
isNew | Argument to specify the identifier of the cube report
Used in following event:
EnumServletEvents.WebEventEditReport |
3134 | ||
openHelp | ||||
Event for opening 'Help' page. |
3046 | |||
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 | ||
openHelpIndex | ||||
Event for opening 'Help Index' page. |
3047 | |||
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 | ||
openHelpSetup | ||||
Event for opening 'Help setup' page. |
3177 | |||
openHistoryPage | ||||
Event for opening a page from the page history |
3124 | |||
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 | ||
openHome | ||||
Event for opening home page of MSTR web application. Default event for the servlet. |
3001 | |||
openHomeCards | ||||
3194 | ||||
openImportEntryPage | ||||
Open DataImport entry page |
3172 | |||
analysisAddMode | Indicates how DI will return to the Analysis page. 1 - Add, 2 - replace, 3 - replace all |
3171 | ||
analysisID | The Analysis Object ID |
3169 | ||
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 | ||
cubeName | Indicates the cube name |
3172 | ||
documentID |
3176 | |||
folderId |
3135 | |||
isEdit | Whether we are editing a cube |
3168 | ||
isNew | Argument to specify the identifier of the cube report
Used in following event:
EnumServletEvents.WebEventEditReport |
3134 | ||
isNewAnalysis | Indicates whether DI will launch the IVE editor directly |
3170 | ||
isRepublish | Whether we are republishing a cube |
3180 | ||
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 | ||
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 | |||
analysisAddMode | Indicates how DI will return to the Analysis page. 1 - Add, 2 - replace, 3 - replace all |
3171 | ||
analysisID | The Analysis Object ID |
3169 | ||
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 | ||
documentID |
3176 | |||
folderId |
3135 | |||
isEdit | Whether we are editing a cube |
3168 | ||
isNew | Argument to specify the identifier of the cube report
Used in following event:
EnumServletEvents.WebEventEditReport |
3134 | ||
isNewAnalysis | Indicates whether DI will launch the IVE editor directly |
3170 | ||
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 | ||
openIPAEnvironmentDetails | ||||
3190 |
|
|||
action |
3001 |
|
||
openMy | ||||
Event for opening 'My Reports' page. |
3003 | |||
openMySubscriptions | ||||
Event for opening the 'My Subscriptions' page. |
3031 | |||
openObjectSubscriptions | ||||
Event for opening the 'My subscriptions' page. All the susbcriptions for an object rather than to a page. |
3032 | |||
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 | ||
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 | ||
openOfficeSetup | ||||
Event for opening the MicroStrategy Office Setup page. |
3110 | |||
openPDFOptions | ||||
Event for opening the 'PDF options' page. |
3039 | |||
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 | ||
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 | ||
openPDFOptionsFromReport | ||||
Event for opening the 'PDF options' page from an active Report page. |
3053 | |||
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 | ||
PDFOutlineModeState | Argument to specify the Outline Mode state.
Used in following event:
EnumServletEvents.WebEventPDFDisplay |
3114 | ||
showOptionsPage | Whether to show the export options page when exporting. Note: Used for customizations only. Used in following event: EnumServletEvents.WebEventFastExport |
3161 | ||
openPrefChPwd | ||||
3167 |
|
|||
openPreferences | ||||
Event for opening the 'Preferences' page. |
3041 | |||
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 | ||
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 | ||
openPrint | ||||
Event for opening the 'Print' page. |
3028 | |||
printAdminFooterFile | Argument to specify the path to the Administrator's footer file.
Used in following event:
EnumServletEvents.WebEventOpenPrint |
3078 | ||
printAdminHeaderFile | Argument to specify the path to the Administrator's header file.
Used in following event:
EnumServletEvents.WebEventOpenPrint |
3077 | ||
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 | ||
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 | ||
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 | ||
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 | ||
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 | ||
printFooterCenterSection | Argument to specify the center section of the page's footer
Used in following event:
EnumServletEvents.WebEventOpenPrint |
3096 | ||
printFooterLeftSection | Argument to specify the left section of the page's footer.
Used in following event:
EnumServletEvents.WebEventOpenPrint |
3095 | ||
printFooterRightSection | Argument to specify the right section of the page's footer.
Used in following event:
EnumServletEvents.WebEventOpenPrint |
3097 | ||
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 | ||
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 | ||
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 | ||
printHeaderCenterSection | Argument to specify the center section of the page's header.
Used in following event:
EnumServletEvents.WebEventOpenPrint |
3093 | ||
printHeaderLeftSection | Argument to specify the left section of the page's header.
Used in following event:
EnumServletEvents.WebEventOpenPrint |
3092 | ||
printHeaderRightSection | Argument to specify the right section of the page's header.
Used in following event:
EnumServletEvents.WebEventOpenPrint |
3094 | ||
printMarginSizeBottom | Argument to specify the paper's bottom margin.
String value for representing an int value. Used in following event: EnumServletEvents.WebEventOpenPrint |
3072 | ||
printMarginSizeLeft | Argument to specify the paper's left margin.
String value for representing an int value. Used in following event: EnumServletEvents.WebEventOpenPrint |
3069 | ||
printMarginSizeRight | Argument to specify the paper's right margin.
String value for representing an int value. Used in following event: EnumServletEvents.WebEventOpenPrint |
3070 | ||
printMarginSizeTop | Argument to specify the paper's top margin.
String value for representing an int value. Used in following event: EnumServletEvents.WebEventOpenPrint |
3071 | ||
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 | ||
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 | ||
printMaxFooterSize | Argument to specify the paper's footer maximum size.
String value for representing an int value. Used in following event: EnumServletEvents.WebEventOpenPrint |
3074 | ||
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 | ||
printMaxHeaderSize | Argument to specify the paper's header maximum size.
String value for representing an int value. Used in following event: EnumServletEvents.WebEventOpenPrint |
3073 | ||
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 | ||
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 | ||
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 | ||
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 | ||
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 | ||
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 | ||
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 | ||
openPrintDocument | ||||
Event for opening the 'Print document' page. |
3030 | |||
openPrintOptions | ||||
Event for opening the 'Print options' page. |
3029 | |||
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 | ||
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 | ||
openPrintOptionsFromReport | ||||
Event for opening the 'Printing oprions' page from an active Report page. |
3052 | |||
openPublicDashbord | ||||
3189 |
|
|||
openPublicShare | ||||
3191 |
|
|||
documentID |
2048001 |
|
||
openRRAcceptanceForm | ||||
Reserved for future use. |
3178 | |||
openRRAccountSettings | ||||
Reserved for future use. |
3179 | |||
openRRUserImport | ||||
Reserved for future use. |
3181 | |||
openRRUserManagement | ||||
Reserved for future use. |
3180 | |||
openRWSaveAs | ||||
Event for opening report writer 'Save as' page. |
3102 | |||
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: |
3013 | ||
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 | ||
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:
|
3031 | ||
saveAsReportSaveAsFlags | Argument to specify the save as flags for the new report/filter/template.
It can have a value from EnumDSSXMLReportSaveAsFlags |
26005 | ||
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 | ||
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 | ||
openSaveAs | ||||
Event for opening 'Save as' page. |
3013 | |||
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: |
3013 | ||
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 | ||
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:
|
3031 | ||
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 | ||
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 | ||
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 | ||
saveFromPrompt | A boolean argument to indicate whether we save from prompting stage.
If this argument is missing, we treat it as false . |
3160 | ||
OpenSaveReportProperties | ||||
Event for opnening the Save Report Properties page used in Export, PDF and Print. |
3131 | |||
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 | ||
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 | ||
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 | ||
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 | ||
openSearch | ||||
Event to open the 'Search' page. |
3040 | |||
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 | ||
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 | ||
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 | ||
openSecuritySetup | ||||
Event for opening 'Security setup' page. |
3049 | |||
openShared | ||||
Event for opening 'Shared Reports' page. |
3002 | |||
openSubscriptionEngineSetup | ||||
Event for opening 'Subscriptions Engine setup' page. |
3050 | |||
openSummary | ||||
Event for opening the 'Summary' page. |
3059 | |||
openTopLevelUserGroups | ||||
Event for opening the top level user groups. |
3112 | |||
openWizard | ||||
Event for opening 'Wizard' page. |
3101 | |||
pdfDisplay | ||||
Event for exporting PDF data back to the client. |
3014 | |||
PDFAdminFooterFile | Argument to specify the path to the Administrator's footer file.
Used in following event:
EnumServletEvents.WebEventPDFDisplay |
3113 | ||
PDFAdminHeaderFile | Argument to specify the path to the Administrator's header file.
Used in following event:
EnumServletEvents.WebEventPDFDisplay |
3112 | ||
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 | ||
PDFExpandPageByFields | Argument to specify whether to expand the page-by fields.
Used in following event:
EnumServletEvents.WebEventPDFDisplay |
3117 | ||
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 | ||
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 | ||
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 | ||
PDFFooterCenterSection | Argument to specify the center section of the page's footer.
Used in following event:
EnumServletEvents.WebEventPDFDisplay |
3049 | ||
PDFFooterLeftSection | Argument to specify the left section of the page's footer.
Used in following event:
EnumServletEvents.WebEventPDFDisplay |
3048 | ||
PDFFooterRightSection | Argument to specify the right section of the page's footer.
Used in following event:
EnumServletEvents.WebEventPDFDisplay |
3050 | ||
PDFHeaderCenterSection | Argument to specify the center section of the page's header.
Used in following event:
EnumServletEvents.WebEventPDFDisplay |
3046 | ||
PDFHeaderLeftSection | Argument to specify the left section of the page's header.
Used in following event:
EnumServletEvents.WebEventPDFDisplay |
3045 | ||
PDFHeaderRightSection | Argument to specify the right section of the page's header.
Used in following event:
EnumServletEvents.WebEventPDFDisplay |
3047 | ||
PDFMarginSizeBottom | Argument to specify the paper's bottom margin.
String value for representing an int value. Used in following event: EnumServletEvents.WebEventPDFDisplay |
3057 | ||
PDFMarginSizeLeft | Argument to specify the paper's left margin.
String value for representing an int value. Used in following event: EnumServletEvents.WebEventPDFDisplay |
3054 | ||
PDFMarginSizeRight | Argument to specify the paper's right margin.
String value for representing an int value. Used in following event: EnumServletEvents.WebEventPDFDisplay |
3055 | ||
PDFMarginSizeTop | Argument to specify the paper's top margin.
String value for representing an int value. Used in following event: EnumServletEvents.WebEventPDFDisplay |
3056 | ||
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 | ||
PDFMaxFooterSize | Argument to specify the paper's footer maximum size. String value for representing an int value. Used in following event: EnumServletEvents.WebEventPDFDisplay |
3059 | ||
PDFMaxHeaderSize | Argument to specify the paper's header maximum size. String value for representing an int value. Used in following event: EnumServletEvents.WebEventPDFDisplay |
3058 | ||
PDFOutlineModeState | Argument to specify the Outline Mode state.
Used in following event:
EnumServletEvents.WebEventPDFDisplay |
3114 | ||
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 | ||
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 | ||
PDFScalingOption | Used in following event:
EnumServletEvents.WebEventOpenAdminFAQs EnumServletEvents.WebEventOpenAdminHelp EnumServletEvents.WebEventOpenAdminHelpIndex |
3102 | ||
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 | ||
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 | ||
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 | ||
quickLogout | ||||
Event for performing a quick logout. |
3019 | |||
reportFlashExport | ||||
Export report to Flash |
3136 | |||
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 | |||
runDocument | ||||
Specifies an event to execute a Document. The possible parameters that can be sent in are |
32001 | |||
documentID | objectID -- argument using for browsing objects. |
1001 | ||
documentName | objectName |
1004 | ||
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 | |||
messageID | Specifies an argument for the message id of a Document instance. |
32202 | ||
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 | |||
cubeID | Specifies the DSSID of the cube report |
4225 | ||
dispFlags | SaveAs display flags. |
4004 | ||
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 | ||
graphHeigth | height of the graph. |
4080 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_HEIGHT |
|
graphWidth | width of the graph. |
4081 | ||
linkAnswers |
4222 | |||
maxWait | Specifies an argument for max wait in report execution. |
4190 | ||
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 | ||
reportID | objectID -- argument using for browsing objects. |
1001 | ||
reportName | objectName |
1004 | ||
reportSubtype |
1005 | |||
reportViewMode | integer argument of EnumWebReportViewMode specifying the report view mode. |
4115 | ||
resultFlags | result flags. |
4003 | ||
saveFlags | save as flags. |
4005 | ||
srcAnswers |
4234 | |||
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 | ||
runReport | ||||
40011 | ||||
dispFlags | Save-as display flags. |
4004 | ||
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 | ||
graphHeight | Height of the graph. |
4080 | ||
graphWidth | Width of the graph. |
4081 | ||
linkAnswers |
4222 | |||
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 | ||
reportID |
1001 |
EnumAttributeBeanEvents.ATTRIBUTE_EVENT_ARGUMENT_ATTRIBUTE_ID |
||
reportName | Specifies an argument for report name. |
1004 | ||
reportViewMode | View mode
(see EnumWebReportViewMode ). |
4115 | ||
resultFlags | result flags. |
4003 | ||
saveFlags | Save-as flags. |
4005 | ||
stateID | State ID of the view. |
4118 | ||
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 | |||
dispFlags | SaveAs display flags. |
4004 | ||
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 | ||
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 | ||
resultFlags | result flags. |
4003 | ||
saveFlags | save as flags. |
4005 | ||
templateID | String argument specifying the templateID. |
4119 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_EXECUTION_TEMPLATE_ID |
|
rwDetails | ||||
Event for getting the report writing document details. |
3105 | |||
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: |
3016 | ||
executionMode | Argument to specify the Execution mode.
Its value comes from EnumRWExecutionModes |
3115 | ||
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 | ||
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 | ||
rwdHTMLExport | ||||
Event for opnening the Save Report Properties page used in Export, PDF and Print. |
3130 | |||
documentID | Object ID. |
2048001 | ||
documentName | Object name. |
2048020 | ||
elementsPromptAnswers | Specifies element prompts' answers in a URL friendly format. |
2048089 |
EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER |
|
execFlags | Execution flags |
2048003 | ||
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 | ||
messageID | Message ID. |
2048002 | ||
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 | |||
executionMode | Argument to specify the Execution mode.
Its value comes from EnumRWExecutionModes |
3115 | ||
gridKey | Section key. |
2048007 | ||
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 | ||
rwExportMode | Argument to specify the export mode.
Used in following event:
EnumServletEvents.WebEventRWExport |
3116 | ||
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 | ||
sliceId |
3152 | |||
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 | ||
documentName | Object name. |
2048020 | ||
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 | ||
executionMode | Argument to specify the Execution mode.
Its value comes from EnumRWExecutionModes |
3115 | ||
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 | ||
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 | ||
mode | Specifies the export mode.
Should be a value from EnumRWExportModes |
2048095 | ||
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 | |||
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 | ||
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 | ||
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 | |||
savePassword | ||||
3009 |
|
|||
target |
3004 |
|
||
schedule | ||||
Event to Open Schedule page. |
3170 | |||
search | ||||
Event for performing any search. |
3016 | |||
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 | ||
folderName | Folder Name info for the Folder QuickSearch in order to pass the folder name to new search page |
3167 | ||
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 | ||
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 | ||
srchStr | Argument to specify a search pattern in quick search events. Search string, used in the following event: EnumServletEvents.WebEventRunSearch |
3009 | ||
selectFilter | ||||
Event to select a filter for template/filter execution. |
3044 | |||
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 | ||
folderID | Specifies the object ID of a WebFolder . |
1001 | ||
systemFolder | Specifies the system folder to browse into. |
2023 | ||
selectTemplate | ||||
Event to select a template for template/filter execution. |
3043 | |||
folderID | Specifies the object ID of a WebFolder . |
1001 | ||
systemFolder | Specifies the system folder to browse into. |
2023 | ||
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 | ||
showSecRoles | ||||
3120 | ||||
WebArchitectEntryPage | ||||
3176 |
Notes
* denotes required field.