Supported Bean: ReportBean
WebBean and ObjectBean
interfaces. It reuses the ObjectBean interface to allow a report to: (a) be
retrieved by name (and with wildcard) (b) retrieve its parent folder bean.
The main methods it provides in this interface are:
transform, but only when the report is retrieved
from the Intelligence Server. In this way, the Report Bean may be instructed on
when to release its XML and re-execute the report. This is done using a simple
expiration time period, in hours.
Event handler: com.microstrategy.web.beans.EnumEventHandlerTypes.HANDLER_TYPE_REPORT (4)
Events
| addDerivedMetricEvent | ||||
Event for adding a new derived metric to the metrics collection.
The position where the new metric should be added needs to be specified.
If not, it is added at the beginning of the metrics collection.
If the EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_METRIC_DESTINATION_POSITION is not specified, the metric
is added at position 1 |
4014 | |||
|
alias | alias for a metric. |
4031 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_METRIC_ALIAS_NAME |
|
|
formula | formula for a derived metric. |
4032 | ||
|
metricPos | destination position of the metric in the metrics collection. |
4029 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_METRIC_DESTINATION_POSITION |
|
| addForm | ||||
| Event for adding attribute form. This event can be used to add attribute form to the view template or just to the working set. The (parent) attribute ID for the attribute form should be specified While adding to the view template, if the attribute does not exist on the template it will be added at the axis/position passed to the event (if axis/position is not passed, the attribute will be added to the end of the Row Axis of the template). If the attribute already exists on the template, the event will add(or, if already existing, move) the attribute form at the position specified. Also, if axis and position information is supplied to the event, the attribute will be moved to the specified axis/position before adding the attribute form. |
4059 | |||
|
*attributeID | Attribute ID |
4167 | ||
|
*formID | DSSID of the form to be added/removed. |
4168 | ||
|
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
|
attAxis | destination axis. |
4008 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_AXIS |
|
|
attPosition | destination position of the template unit. |
4009 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_POSITION |
|
|
formPos | the position within the attribute forms collection where a form should be added/moved. |
4170 | ||
|
isbase | specifies whether the add/remove form operation should be applied to the working set. |
4169 | ||
| addMetric | ||||
Adds the metric passed in with the specified key. If a key is not specified, the
metric is added to the beggining of the metric collection. If a metrics collection, does
not already exist on the template, the destination axis and position of the template unit where
the metrics collection should be placed, needs to be specified.
If EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_METRIC_ALIAS_NAME is missing, and the newly added metric exists in working set,
the alias of themetric in workingset will be set as default alias of this template metric; if the newly added
metric does not exist in working set, no alias will be set,
the display of this template metric will be the name of the metric.
The arguments EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_AXIS and
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_POSITION are used if the metrics
collection is not defined on the template. These parameters define where the new collection
will be placed. |
4036 | |||
|
*metricID | String argument specifying the id of the metric. |
4122 | ||
|
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
|
dAxis | destination axis. |
4008 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_AXIS |
|
|
dPos | destination position of the template unit. |
4009 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_POSITION |
|
|
metricDisplayName | alias for a metric. |
4031 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_METRIC_ALIAS_NAME |
|
|
metricKey | key of a specific metric in the collection. |
4010 | ||
|
metricName | name of the metric |
4201 | ||
|
mPos | destination position of the metric in the metrics collection. |
4029 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_METRIC_DESTINATION_POSITION |
|
| addShortcutMetric | ||||
| Specifies an event to add shortcut metric. |
4081 | |||
|
*functionType | Add shortcut Metric. EnumReportBeanEvents.REPORT_EVENT_ADD_SHORTCUT_METRIC |
4235 | ||
|
functionType2 |
4236 | |||
|
unitsCollection |
4237 | |||
| addTemplateUnit | ||||
| Event for adding a new template unit to the template. |
4010 | |||
|
*dAxis | destination axis. |
4008 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_AXIS |
|
|
*dPos | destination position of the template unit. |
4009 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_POSITION |
|
|
*unitID | dss id of the template unit. |
4027 | ||
|
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
|
unitDisplayName | new alias of the template unit. |
4014 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_ALIAS_NAME |
|
|
unitName | name of the object on this template unit |
4200 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_NAME |
|
|
unitType | type of template unit, as defined in EnumDSSXMLTemplateUnitType. |
4026 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_TYPE |
|
| applyChangesEvent | ||||
| Event for applying the changes made on the report. |
4028 | |||
|
includeStyle | boolean property to specify, if the event should do a check for user autostyle preference and apply if there's one. |
4074 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_INCLUDE_USER_STYLE |
|
| browseEvent | ||||
| event for browsing a given object. |
1001 | |||
|
*objectID | objectID -- argument using for browsing objects. |
1001 | ||
|
executionFlags | flags -- integer argument specifying the flags (from EnumDSSXMLObjectFlags ) to be used while performing
object browse operations. |
1003 | ||
| cancelRepromptRequestEvent | ||||
| Event for canceling a reprompt request. |
4046 | |||
| cancelRequestEvent | ||||
| Event for canceling the request. |
4042 | |||
| changeMetricFormulaEvent | ||||
| Event for changing the formula and/or alias associated with a metric. The metric should be specified using it's key. If the key represents a derived metric, that metric's formula will be changed; if the key represents a normal metric, the normal metric will be removed, and a new derived metric based on the formular will be created at the same position. |
4015 | |||
|
*formula | formula for a derived metric. |
4032 | ||
|
*key | key of a specific metric in the collection. |
4010 | ||
|
alias | alias for a metric. |
4031 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_METRIC_ALIAS_NAME |
|
| changeReportStyleEvent | ||||
| Event for changing the style of a report. The style to be applied can be specified either by Id or name. The ID is first checked. If it not supplied, the name is used. |
4017 | |||
|
reportStyleID | style ID of the report. |
4041 | ||
|
reportStyleName | String argument specifying the name of the style to apply. |
4126 | ||
| changeViewMode | ||||
| Event for change report view mode to grid, graph or both. |
4031 | |||
|
*viewMode | integer argument of EnumWebReportViewMode specifying the report view mode. |
4115 | ||
|
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
| clearPageBy | ||||
| Event for clearing the page by axis. |
4051 | |||
| clearSorts | ||||
| Clears all the WebSorts objects contained in the report. |
4037 | |||
|
oAxis | origin axis. |
4006 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_AXIS |
|
| defineDatamart | ||||
| This event would convert a report to datamart. The possible parameters that can be sent in are: |
4072 | |||
|
*dbRoleID | The DB Role ID. |
4204 | ||
|
*tableName | The datamart table name |
4205 | ||
|
append | Datamart property that specifies whether to append to existing t able |
4206 | ||
|
isPattern | Datamart property that specifies whether the datamart name speci fied has tokens or not. |
4207 | ||
| drillToFixedTemplateFromDocumentToReport | ||||
| Event for performing a filter on selections on a grid in a document to the report outside of the document. This will basically perform a drill to fixed template. The node key, view mode and the content tree type for the grid need to be specified. |
4077 |
EnumReportBeanEvents.REPORT_EVENT_DRILL_TO_FIXED_TEMPLATE_FROM_DOCUMENT_TO_REPORT |
||
|
displayMode | Specifies the display mode. A value from the enumeration EnumDSSXMLDisplayMode |
4212 | ||
|
nodeKey | Specifies the node key of the grid-graph object in the doccument |
4226 | ||
|
rwGroupByElements | Specifies the page by elements on the report writing document for the
grid graph object that was drilled on. These are separated by EnumReportBeanEvents.METRIC_ELEM_LIST_SEPARATOR |
4223 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_RW_GROUP_BY_ELEMENTS |
|
|
rwMesageID | String argument specifying the message id of a report instance. |
4112 | ||
|
sliceId |
4224 | |||
|
treeType | Specifies the tree type to which the grid-graph object in the doccument belongs to |
4227 | ||
| editAttributeForms | ||||
| Event for editing attribute forms collection, includes adding/removing forms from base and view, reorder forms in view. The way to carry this event is that client generates the ordered list of all forms on the base, defining each form by its form id and a flag about whether this form is on base or view. |
4067 | |||
|
*attForms | The value of this argument is an ordered (ordered regard of forms in view,
the order is ignored for base forms) list of all forms on the base,
defining each form by its form id and a flag about whether this form is on the view.
The separator between two forms definition is EnumReportBeanEvents.FORM_LIST_SEPARATOR; the form id and the
boolean flag about whether the form on the view("1" for on the view, "0" for on working set only) will be separated by EnumReportBeanEvents.FORM_ELEM_SEPARATOR.
For example, a collection of two forms, form 1 is on base only, and form 2 on base and also on the view.
The value for this argument would be form1_IDEnumReportBeanEvents.FORM_ELEM_SEPARATOR0EnumReportBeanEvents.FORM_LIST_SEPARATORform2_IDEnumReportBeanEvents.FORM_ELEM_SEPARATOR1 |
4196 | ||
|
*attributeID | Attribute ID |
4167 | ||
|
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
| executeWithTemplateFilter | ||||
| Sets the flags for execution based on templateID and filterID. |
4033 | |||
|
*filterID | String argument specifying the filterID. |
4120 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_EXECUTION_FILTER_ID |
|
|
*templateID | String argument specifying the templateID. |
4119 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_EXECUTION_TEMPLATE_ID |
|
|
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 | ||
|
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 |
|
|
promptsAnswerXML | Specifies an argument for the original report's prompt answer XML in document drilling. |
4188 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML |
|
|
resultFlags | result flags. |
4003 | ||
|
saveFlags | save as flags. |
4005 | ||
|
valuePromptAnswers | Specifies an argument for the new prompt answer for
WebConstantPrompt in
document drilling. |
4220 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER |
|
| graphDrillEvent | ||||
| Event for performing a drill on the report graph. The coordinates on which to drill should be specified. |
4013 | |||
|
*4013.x | list of elements. |
4036 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DRILL_GRAPH_XPIXEL |
|
|
*4013.y | list of elements. |
4037 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DRILL_GRAPH_YPIXEL |
|
|
drillPathKey | Specifies an argument for the drill path key. |
4195 | ||
|
graphHeight | height of the graph. |
4080 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_HEIGHT |
|
|
graphWidth | width of the graph. |
4081 | ||
|
keepThresholds | specifies whether the thresholds should be kept after performing the drill operation. |
4134 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DRILL_RETAIN_THRESHOLDS |
|
| graphDrillFromDocumentToReport | ||||
| Event for performing a drill on the graph in a document to the report outside of the document. The template unit needs to the specified using the axis and position. The drill path is picked up based on the ID passed in. |
4076 |
EnumReportBeanEvents.REPORT_EVENT_GRAPH_DRILL_FROM_DOCUMENT_TO_REPORT |
||
|
3126.x | list of elements. |
4036 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DRILL_GRAPH_XPIXEL |
|
|
3126.y | list of elements. |
4037 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DRILL_GRAPH_YPIXEL |
|
|
displayMode | Specifies the display mode. A value from the enumeration EnumDSSXMLDisplayMode |
4212 | ||
|
drillPathKey | Specifies an argument for the drill path key. |
4195 | ||
|
graphHeight | height of the graph. |
4080 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_HEIGHT |
|
|
graphWidth | width of the graph. |
4081 | ||
|
retainParent | specifies whether the parent should be kept after performing the drill operation. |
4034 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DRILL_RETAIN_PARENT |
|
|
retainThresh | specifies whether the thresholds should be kept after performing the drill operation. |
4134 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DRILL_RETAIN_THRESHOLDS |
|
|
rwGroupByElements | Specifies the page by elements on the report writing document for the
grid graph object that was drilled on. These are separated by EnumReportBeanEvents.METRIC_ELEM_LIST_SEPARATOR |
4223 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_RW_GROUP_BY_ELEMENTS |
|
|
rwMesageID | String argument specifying the message id of a report instance. |
4112 | ||
|
sliceId |
4224 | |||
| gridDrillEvent | ||||
| Event for performing a drill on the report grid. The template unit needs to the specified using the axis and position. The drill path is picked up based on the ID passed in. The caller can also specify a list of elements that the drill needs to filter the results on. |
4012 | |||
|
displayMode | Specifies the display mode. A value from the enumeration EnumDSSXMLDisplayMode |
4212 | ||
|
drillImp | level of drill importance to retrieve.
possible values are:
EnumReportBeanEvents.DRILL_IMPORTANCE_LOW
EnumReportBeanEvents.DRILL_IMPORTANCE_MEDIUM
EnumReportBeanEvents.DRILL_IMPORTANCE_HIGH |
4124 | ||
|
drillKey | key for drilling.
axis<separator>position<separator>ordinal<separator>drillPathID
The <separator> is EnumReportBeanEvents.DRILL_TO_KEY_SEPARATOR |
4033 | ||
|
drillPathKey | Specifies an argument for the drill path key. |
4195 | ||
|
elementList | list of elements.
This is a list of element IDs separated by EnumReportBeanEvents.METRIC_ELEM_LIST_SEPARATOR |
4035 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DRILL_ELEMENT_LIST |
|
|
filterOnPageBy | Argument specifying whether to filter on the Page By axis during drilling. |
4147 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DRILL_FILTER_ON_PAGE_BY |
|
|
retainParent | specifies whether the parent should be kept after performing the drill operation. |
4034 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DRILL_RETAIN_PARENT |
|
|
retainThresh | specifies whether the thresholds should be kept after performing the drill operation. |
4134 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DRILL_RETAIN_THRESHOLDS |
|
| gridDrillFixTemplateEvent | ||||
| Event for performing a drill with the template fixed. This just filters on a given list of elements. |
4040 | |||
|
elementList | list of elements.
This is a list of element IDs separated by EnumReportBeanEvents.METRIC_ELEM_LIST_SEPARATOR |
4035 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DRILL_ELEMENT_LIST |
|
|
filterOnPageBy | Argument specifying whether to filter on the Page By axis during drilling. |
4147 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DRILL_FILTER_ON_PAGE_BY |
|
|
retainThresh | specifies whether the thresholds should be kept after performing the drill operation. |
4134 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DRILL_RETAIN_THRESHOLDS |
|
| gridDrillFromDocumentToReport | ||||
| Event for performing a drill on the grid in a document to the report outside of the document. The template unit needs to the specified using the axis and position. The drill path is picked up based on the ID passed in. The caller can also specify a list of elements that the drill needs to filter the results on. |
4075 |
EnumReportBeanEvents.REPORT_EVENT_GRID_DRILL_FROM_DOCUMENT_TO_REPORT |
||
|
*drillPathKey | Specifies an argument for the drill path key. |
4195 | ||
|
*rwMesageID | String argument specifying the message id of a report instance. |
4112 | ||
|
displayMode | Specifies the display mode. A value from the enumeration EnumDSSXMLDisplayMode |
4212 | ||
|
elementList | list of elements.
This is a list of element IDs separated by EnumReportBeanEvents.METRIC_ELEM_LIST_SEPARATOR |
4035 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DRILL_ELEMENT_LIST |
|
|
filterOnPageBy | Argument specifying whether to filter on the Page By axis during drilling. |
4147 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DRILL_FILTER_ON_PAGE_BY |
|
|
retainParent | specifies whether the parent should be kept after performing the drill operation. |
4034 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DRILL_RETAIN_PARENT |
|
|
retainThresh | specifies whether the thresholds should be kept after performing the drill operation. |
4134 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DRILL_RETAIN_THRESHOLDS |
|
|
rwGroupByElements | Specifies the page by elements on the report writing document for the
grid graph object that was drilled on. These are separated by EnumReportBeanEvents.METRIC_ELEM_LIST_SEPARATOR |
4223 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_RW_GROUP_BY_ELEMENTS |
|
|
sliceId |
4224 | |||
| hierarchicalSort | ||||
Event for applying hierarchical metric sort in outline mode. If the subtotal
parameter is not specified, the default is EnumDSSXMLMetricType.DssXmlMetricSubtotalSum. |
4039 | |||
|
*sortKey | sort key.
The format of the key is as follows:
EnumReportBeanEvents.SORT_PARAM_TYPE=type<sep>EnumReportBeanEvents.SORT_PARAM_ID=id<sep>EnumReportBeanEvents.SORT_PARAM_FORM_ID=id<sep>EnumReportBeanEvents.SORT_PARAM_FORM_TYPE=type<sep>EnumReportBeanEvents.SORT_PARAM_ELEM_LIST<sep>EnumReportBeanEvents.SORT_PARAM_AXIS
where <sep> is EnumReportBeanEvents.SORT_PARAM_SEPARATOR
SORT_PARAM_ELEM_LIST is a list of elements separated by EnumReportBeanEvents.SORT_ELEM_LIST_SEPARATOR |
4011 | ||
|
_subtotalPos | argument indicating where the subtotals should be placed once the sorting is performed. |
4138 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SORT_SUBTOTAL_POSITION |
|
|
_subTotalType | type of subtotal to be added/removed. |
4015 | ||
|
clearSorts | specifies whether the previous sorts should be cleared before adding the current ones. |
4013 | ||
|
sortOrder | order of the sort -- EnumReportBeanEvents.SORT_ORDER_ASCENDING/EnumReportBeanEvents.SORT_ORDER_DESCENDING.
The default is EnumReportBeanEvents.SORT_ORDER_ASCENDING |
4012 | ||
|
sortsCount | number of sorts that should be applied to the report. |
4123 | ||
| incrementalFetch | ||||
Event for doing an incremental fetch on the report using its
ReportPageInfo. |
4050 | |||
|
*pageInfoType | argument indicating the type of report page info. Absolute or Relative.
Possible values are listed in EnumReportPageType |
4139 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_REPORT_PAGE_INFO_TYPE |
|
|
xPos | Argument indicating the X Position of the desired page on a report |
4142 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_REPORT_PAGE_INFO_XPOS |
|
|
yPos | Argument indicating the Y Position of the desired page on a report |
4143 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_REPORT_PAGE_INFO_YPOS |
|
| initializeFromSchedule | ||||
| Event for initializing the report bean using a schedule. |
4057 | |||
|
*triggerID | String argument indicating the trigger to be used. |
4127 | ||
|
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 | ||
| 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 | ||
|
reportViewMode | integer argument of EnumWebReportViewMode specifying the report view mode. |
4115 | ||
|
saveToInbox | Specifies whether to save the message to inbox. |
4172 | ||
| moveMetric | ||||
| Event for moving a metric within the metric collection. The origin and the destination position should be specified. |
4011 | |||
|
*dPos | destination position of the metric in the metrics collection. |
4029 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_METRIC_DESTINATION_POSITION |
|
|
*oPos | starting position of the metric in the metrics collection. |
4028 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_METRIC_ORIGIN_POSITION |
|
|
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
| multipleSorts | ||||
Event for setting multiple sort objects. Similar to EnumReportBeanEvents.REPORT_EVENT_HIERARCHICAL_METRIC_SORT
except that this event allows users to specify multiple sorts at the same time. The count parameter
should be passed to indicate the number of sorts. |
4038 | |||
|
*sortKey | sort key.
The format of the key is as follows:
EnumReportBeanEvents.SORT_PARAM_TYPE=type<sep>EnumReportBeanEvents.SORT_PARAM_ID=id<sep>EnumReportBeanEvents.SORT_PARAM_FORM_ID=id<sep>EnumReportBeanEvents.SORT_PARAM_FORM_TYPE=type<sep>EnumReportBeanEvents.SORT_PARAM_ELEM_LIST<sep>EnumReportBeanEvents.SORT_PARAM_AXIS
where <sep> is EnumReportBeanEvents.SORT_PARAM_SEPARATOR
SORT_PARAM_ELEM_LIST is a list of elements separated by EnumReportBeanEvents.SORT_ELEM_LIST_SEPARATOR |
4011 | ||
|
_subtotalPos | argument indicating where the subtotals should be placed once the sorting is performed. |
4138 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SORT_SUBTOTAL_POSITION |
|
|
clearSorts | specifies whether the previous sorts should be cleared before adding the current ones. |
4013 | ||
|
sortOrder | order of the sort -- EnumReportBeanEvents.SORT_ORDER_ASCENDING/EnumReportBeanEvents.SORT_ORDER_DESCENDING.
The default is EnumReportBeanEvents.SORT_ORDER_ASCENDING |
4012 | ||
|
sortsCount | number of sorts that should be applied to the report. |
4123 | ||
| pageByNavigator | ||||
| Event for navigate pages for the report page-by operation. |
4045 | |||
|
direction | String argument specifying whether to move to the next page or the previous page. A value of 1 means moving forward, and -1 means moving backward. The default value is 1 if not specified. |
4137 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_PAGE_BY_NAVIGATION_DIRECTION |
|
| redo | ||||
| Event for redo current report to next state. |
4064 | |||
| refreshReport | ||||
| Event for refreshing a report. The caller can specify whether the report should be reexecuted. The caller can specify whether the prompts should be refreshed and can also refresh a particular state of the report. |
4047 | |||
|
fresh | Argument indicating whether the report should be re-executed with fresh execution flags. |
4145 | ||
|
rePrompt | rePrompting option for refreshing a report. |
4136 | ||
|
stateID | state id of a report instance. |
4113 | ||
| removeAllWorkingSetMetrics | ||||
| Specifies an event to remove all working set metrics. |
4061 |
EnumReportBeanEvents.REPORT_EVENT_REMOVE_ALL_WORKING_SET_METRICS |
||
|
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
| removeForm | ||||
| Event for removing attribute form. This event can be used to add attribute form to the view template or just to the working set. The (parent) attribute ID for the attribute form should be specified. |
4060 | |||
|
*attributeID | Attribute ID |
4167 | ||
|
*formID | DSSID of the form to be added/removed. |
4168 | ||
|
isbase | specifies whether the add/remove form operation should be applied to the working set. |
4169 | ||
| removeMultipleUnitsFromWorkingSet | ||||
Event to remove multiple units at the same time. These units can be real template units like attributes,
custom groups, hierarchies etc or they can also be individual metrics or even attribute forms.
Please see EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_MULTIPLE_UNITS for more details on the format
of the arguments |
4074 |
EnumReportBeanEvents.REPORT_EVENT_REMOVE_MULTIPLE_UNITS_FROM_WORKING_SET |
||
|
*multipleUnits | Specifies the multiple units that need to be removed from working set
The argument is of the following format
type1,DSSID1 ! type2,DSSID2 ! type3, attributeID, formID...where type is from
EnumDSSXMLObjectTypes; '-1' is for the metrics collection;
The separators used are EnumReportBeanEvents.UNIT_PROPERTY_SEPARATOR and EnumReportBeanEvents.MULTIPLE_UNITS_SEPARATOR.
The order of these properties needs to be conformed to the above syntax. |
4213 | ||
| removeWorkingSetObjectEvent | ||||
| Event for removing a unit from the working set. |
4019 | |||
|
*objectID | object ID to remove from the working set. |
4165 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_WORKING_SET_OBJECT_ID |
|
|
*objectSubType | Argument indicating the subtype of the object. |
4164 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_WORKING_SET_OBJECT_SUB_TYPE |
|
|
*objectType | object type to remove from the working set. |
4166 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_WORKING_SET_OBJECT_TYPE |
|
|
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
| ReportAliasEvent | ||||
Event for specifying the alias of a template unit. The template unit can be
identified either using the key or the axis/position
If the EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_METRIC_KEY is supplied, the event changes the alias of the metric
Otherwise, it looks for the EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_KEY |
4005 | |||
|
*alias | new alias of the template unit. |
4014 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_ALIAS_NAME |
|
|
key | key of the template unit. |
4030 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_KEY |
|
|
metricDepth | key of a specific metric in the collection. |
4010 | ||
|
oAxis | origin axis. |
4006 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_AXIS |
|
|
oPos | origin position of the template unit. |
4007 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_POSITION |
|
| ReportDisableSubTotalsEvent | ||||
| Event for disabling either a specific type of subtotal. If the type is not specified, all the subtotals are disabled. |
4007 | |||
|
_subTotalType | type of subtotal to be added/removed. |
4015 | ||
| ReportEnableSubTotalsEvent | ||||
| Event for enabling the subtotals of the specified type and style. The subtotals are added to a specific axis, if one is specified. Otherwise they are added to all axes. |
4006 | |||
|
*_subtotalStyle | subtotal style. |
4016 | ||
|
*_subTotalType | type of subtotal to be added/removed. |
4015 | ||
|
oAxis | origin axis. |
4006 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_AXIS |
|
| ReportExecuteEvent | ||||
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 | ||
|
graphHeight | 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 | ||
|
msgID | 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 |
|
|
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 | ||
| ReportPivotEvent | ||||
| Event for performing pivot. The callers needs to specify the template unit for the origin and the destination. These can be specified using the axis and position. |
4002 | |||
|
*dAxis | destination axis. |
4008 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_AXIS |
|
|
*dPos | destination position of the template unit. |
4009 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_POSITION |
|
|
*oAxis | origin axis. |
4006 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_AXIS |
|
|
*oPos | origin position of the template unit. |
4007 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_POSITION |
|
|
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
| ReportRemoveMetricEvent | ||||
| Removes a metric based on the specified key or position. If the key or position are not specified, then all the metrics are removed. |
4035 | |||
|
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
|
metricKey | key of a specific metric in the collection. |
4010 | ||
|
oPos | starting position of the metric in the metrics collection. |
4028 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_METRIC_ORIGIN_POSITION |
|
| ReportRemoveTemplateEvent | ||||
| Event for removing a specific template unit from the report template. The template to be removed can be specified using either the key or the axis and position. |
4003 | |||
|
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
|
key | key of the template unit. |
4030 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_KEY |
|
|
oAxis | origin axis. |
4006 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_AXIS |
|
|
oPos | origin position of the template unit. |
4007 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_POSITION |
|
| reportSaveAs | ||||
| Event for saving a report back into metadata. This requires a name and a parrent folderID. The arguments that are supported are |
4016 | |||
|
*parentFolderID | SaveAs parent folder. |
4040 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SAVE_AS_PARENT_FOLDER_ID |
|
|
*reportName | SaveAs report name. |
4038 | ||
|
outlineLevel | Specifies the outline level. A value of -1 means fully expanded, 0 means collapsed. Any positive number means to which column the report is expanded. |
4173 | ||
|
reportDescription | SaveAs report description. |
4039 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SAVE_AS_DESCRIPTION |
|
|
saveAsDisplayMode | SaveAs display flags. |
4004 | ||
|
saveAsFlags | save as flags. |
4005 | ||
| ReportSortEvent | ||||
| Event for setting the sort object.Defines the sorts to be added. |
4004 | |||
|
*sortKey | sort key.
The format of the key is as follows:
EnumReportBeanEvents.SORT_PARAM_TYPE=type<sep>EnumReportBeanEvents.SORT_PARAM_ID=id<sep>EnumReportBeanEvents.SORT_PARAM_FORM_ID=id<sep>EnumReportBeanEvents.SORT_PARAM_FORM_TYPE=type<sep>EnumReportBeanEvents.SORT_PARAM_ELEM_LIST<sep>EnumReportBeanEvents.SORT_PARAM_AXIS
where <sep> is EnumReportBeanEvents.SORT_PARAM_SEPARATOR
SORT_PARAM_ELEM_LIST is a list of elements separated by EnumReportBeanEvents.SORT_ELEM_LIST_SEPARATOR |
4011 | ||
|
_subtotalPos | argument indicating where the subtotals should be placed once the sorting is performed. |
4138 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SORT_SUBTOTAL_POSITION |
|
|
clearSorts | specifies whether the previous sorts should be cleared before adding the current ones. |
4013 | ||
|
sortOrder | order of the sort -- EnumReportBeanEvents.SORT_ORDER_ASCENDING/EnumReportBeanEvents.SORT_ORDER_DESCENDING.
The default is EnumReportBeanEvents.SORT_ORDER_ASCENDING |
4012 | ||
| resetChangesEvent | ||||
| Event for reseting the changes made on the report. |
4029 | |||
| resetState | ||||
| resets the stateID |
4048 | |||
| resizeColumn | ||||
Event for resizing the an individual column width or all columns. This event supports sending
a single column resize request. The request can be to resize an individual column or to resize
all columns to the same width. In order to resize all columns, the EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_COLUMN_IDENTIFIER
argument should be set to "allcolumns". |
4054 | |||
|
*columnIdentifier | Argument specifying a column identifier. For a given column, its
identifier can be obtained using WebColumn.getKey(). If the request to resize is for All Columns
then the column identifier should be sent as the string AllColumns (case insensitive). |
4159 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_COLUMN_IDENTIFIER |
|
|
*newSize | Argument specifying the new column size for a column resize request. |
4160 | ||
|
gridWidth | Argument specifying the default grid width for a column scenario of type EnumDSSXMLWidthScenario.DssXmlWidthFixed |
4156 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DEFAULT_GRID_WIDTH |
|
|
headerWidth | Argument specifying the default header width for a column scenario of type EnumDSSXMLWidthScenario.DssXmlWidthFixed |
4155 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DEFAULT_HEADER_WIDTH |
|
| resizeColumns | ||||
| Event for resizing the column widths. This event supports sending multiple column resize requests. |
4053 | |||
|
*requests | Argument specifying the resize requests for column resizing. The resize requests should be be sequenced as an ordered
list of requests (that will be processed in the order sent) seperated by underscores. Each request is further a colon
seperated list of [1] column identifier and [2] new size. For a given column, its
identifier can be obtained using WebColumn.getKey(). If the request to resize is for All Columns
then the column identifier should be sent as the string AllColumns (case insensitive). |
4158 | ||
|
gridWidth | Argument specifying the default grid width for a column scenario of type EnumDSSXMLWidthScenario.DssXmlWidthFixed |
4156 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DEFAULT_GRID_WIDTH |
|
|
headerWidth | Argument specifying the default header width for a column scenario of type EnumDSSXMLWidthScenario.DssXmlWidthFixed |
4155 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DEFAULT_HEADER_WIDTH |
|
| saveAssociatedSchedules | ||||
| Specifies an event to save associated schedule. |
4082 | |||
|
*nonSchedulable |
4238 | |||
|
scheduleList |
4239 | |||
| saveAssociatedUsers | ||||
| Specifies an event to save associated users |
4083 | |||
|
*allowUsersSubscribe | allow users to subcribe a subscripiton 1 means allow, 0 means deny |
4241 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_ALLOW_USER_SUBSCRIBE |
|
|
userList | the associated user list for a subscription, this is a String including multiple user's name, user's id and user's ACL for example 54F3D26011D2896560009A8E67019608~199~Administrator E96A7B6911D4BBCE10004694316DE8A4~199~Barbara Aoter |
4242 | ||
| saveEmailSubscriptionEvent | ||||
Event for saving an e-mail subscription. The caller has to specify a
valid address and triggerID. The event assumes that the report is in a ready state
|
4044 | |||
|
*triggerID | String argument indicating the trigger to be used. |
4127 | ||
|
addressID | String argument indicating the address ID. |
4129 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_ID |
|
|
addressValues | String argument indicating the physical addresses to be used for subscription. |
4130 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_VALUES |
|
|
cmsg | Message to be saved along with the email subscription |
4150 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_CUSTOM_MESSAGE |
|
|
deviceID | String argument indicating the deviceID. |
4131 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_DEVICE_ID |
|
|
emailSubject | String argument indicating the email subject to be used for subscription. |
4132 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_EMAIL_SUBJECT |
|
|
fModeExAll | Denotes whether the only the current page (value of "0"), or all pages is applied to the subscription (value of "1"). |
4194 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_CONTENT_FORMAT_MODE_ALL_PAGES |
|
|
fModeSep | Denotes whether multiple pages should be separated (value of "1") on different worksheets - currently only applicable to Excel exports. |
4208 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_CONTENT_FORMAT_MODE_SEPARATED_PAGES |
|
|
fstate | The serialized state of the delivery format |
4151 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_FORMAT_STATE |
|
|
locKey | location key for scheduled file and print export |
4180 | ||
|
sendNow | String argument indicating sendnow property for subscription. |
4133 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_SEND_NOW |
|
|
zip | Indicates whether the format should be zipped |
4152 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_ZIP_CONTENTS |
|
| saveFileSubscriptionEvent | ||||
| Specifies an event to save subscription to a file. |
4070 | |||
|
*triggerID | String argument indicating the trigger to be used. |
4127 | ||
|
addressValues | String argument indicating the physical addresses to be used for subscription. |
4130 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_VALUES |
|
|
cmsg | Message to be saved along with the email subscription |
4150 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_CUSTOM_MESSAGE |
|
|
fileName | file name for scheduled file export |
4181 | ||
|
fModeExAll | Denotes whether the only the current page (value of "0"), or all pages is applied to the subscription (value of "1"). |
4194 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_CONTENT_FORMAT_MODE_ALL_PAGES |
|
|
fModeSep | Denotes whether multiple pages should be separated (value of "1") on different worksheets - currently only applicable to Excel exports. |
4208 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_CONTENT_FORMAT_MODE_SEPARATED_PAGES |
|
|
fstate | The serialized state of the delivery format |
4151 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_FORMAT_STATE |
|
|
locKey | location key for scheduled file and print export |
4180 | ||
|
notifyAddressID | Subscription notification is sent to this existing address. |
4176 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_ID |
|
|
notifyAddressValue | Subscription notification is sent to this new address. If this is supplied, it
takes precedence over
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_ID. |
4177 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_VALUE |
|
|
notifyDeviceID | Specifies an event argument for subscription notification device id. |
4178 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_DEVICE_ID |
|
|
sendNow | String argument indicating sendnow property for subscription. |
4133 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_SEND_NOW |
|
|
zip | Indicates whether the format should be zipped |
4152 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_ZIP_CONTENTS |
|
| saveGraphAxisProperties | ||||
| Event for saving the graph axis properties. |
4027 |
EnumReportBeanEvents.REPORT_EVENT_SAVE_GRAPH_AXIS_PROPERTIES |
||
|
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
|
scaleX | scale of the X axis. |
4104 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_SCALEX |
|
|
scaleY1 | scale of the Y1 axis. |
4105 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_SCALEY1 |
|
|
scaleY2 | scale of the Y2 axis. |
4106 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_SCALEY2 |
|
|
scaleZ | scale of the Z axis. |
4107 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_SCALEZ |
|
|
show2DOLabel | specifies whether to show the 2DO Label. |
4092 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_SHOW2DOLABEL |
|
|
show2DXValue | specifies whether to show the 2DX value. |
4093 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_SHOW2DXVALUE |
|
|
show2DY1Value | specifies whether to show the 2DY1 value. |
4094 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_SHOW2DY1VALUE |
|
|
show2DY2Value | specifies whether to show the 2DY2 value. |
4095 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_SHOW2DY2VALUE |
|
|
show3DCHeader | specifies whether to show the 3DC header. |
4096 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_SHOW3DCHEADER |
|
|
show3DLNumber | specifies whether to show the 3DL number. |
4097 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_SHOW3DLNUMBER |
|
|
show3DRHeader | specifies whether to show the 3DR header. |
4099 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_SHOW3DRHEADER |
|
|
show3DRNumber | specifies whether to show the 3DR number. |
4098 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_SHOW3DRNUMBER |
|
|
stepX | step of the X axis. |
4100 | ||
|
stepY1 | step of the Y1 axis. |
4101 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_STEPY1 |
|
|
stepY2 | step of the Y2 axis. |
4102 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_STEPY2 |
|
|
stepZ | step of the Z axis. |
4103 | ||
| saveGraphProperties | ||||
| Event for saving the graph properties. |
4025 | |||
|
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
|
autosizeH | Specifies an argument for auto size horizontally. |
4191 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_AUTOSIZE_HORIZONTAL |
|
|
autosizeV | Specifies an argument for auto size vertically. |
4192 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_AUTOSIZE_VERTICAL |
|
|
enableTotals | Specifies an argument for enabling totals. |
4198 | ||
|
height | height of the graph. |
4080 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_HEIGHT |
|
|
majorType | major type of the graph. |
4082 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_MAJORTYPE |
|
|
minorType | minor type of the graph. |
4083 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_MINORTYPE |
|
|
seriesByColumns | Specifies an argument for graph series. |
4197 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SERIES_BY_COLUMNS |
|
|
width | width of the graph. |
4081 | ||
| saveGraphTextProperties | ||||
| Event for saving the graph text properties. |
4026 |
EnumReportBeanEvents.REPORT_EVENT_SAVE_GRAPH_TEXT_PROPERTIES |
||
|
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
|
attributeID | specifies an attribute in the graph. |
4202 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_ATTRIBUTEID |
|
|
content | content of the graph object. |
4091 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_CONTENT |
|
|
fillColor | Specifies the fill color in the graph |
4211 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_FILL_COLOR |
|
|
fontAlign | font align property of the graph object. |
4086 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_FONT_ALIGN |
|
|
fontColor | font color property of the graph object. |
4087 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_FONT_COLOR |
|
|
fontName | font name property of the graph object. |
4088 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_FONT_NAME |
|
|
fontSize | font size property of the graph object. |
4090 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_FONT_SIZE |
|
|
fontStyle | font style property of the graph object. |
4089 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_FONT_STYLE |
|
|
lineColor | Specifies the line color in the graph |
4210 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_LINE_COLOR |
|
|
objectID | specifies an object in the graph. |
4085 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_OBJECTID |
|
|
propValue | specifies a graph property value. |
4203 | ||
|
seriesID | specifies a series in the graph. |
4209 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPHPROPS_SERIESID |
|
|
show | show property of the graph object. |
4084 | ||
| saveGridAlignmentProperties | ||||
| Event for saving the grid alignment properties. |
4021 |
EnumReportBeanEvents.REPORT_EVENT_SAVE_GRID_ALIGNMENT_PROPERTIES |
||
|
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
|
gridLevel | level of the grid unit when saving
the grid properties. The possible values are: 1 - Grid 2 - Header 3 - Subtotal grid 4 - Subtotal header |
4109 | ||
|
gridUnit | unit of the grid. The possible
values are: 1 - Template Unit 2 - Template Metric 3 - Rows 4 - Cols |
4108 | ||
|
horizontal | specifies horizontal alignment. |
4056 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_ALIGNMENT_HORIZONTAL |
|
|
oAxis | origin axis. |
4006 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_AXIS |
|
|
oPos | origin position of the template unit. |
4007 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_POSITION |
|
|
styleName | String argument specifying the name of the style to apply. |
4126 | ||
|
textWrap | specifies text wrap. |
4058 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_ALIGNMENT_WRAP |
|
|
vertical | specifies vertical alignment. |
4057 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_ALIGNMENT_VERTICAL |
|
| saveGridBandingProperties | ||||
| Event for saving the grid banding properties. |
4024 |
EnumReportBeanEvents.REPORT_EVENT_SAVE_GRID_BANDING_PROPERTIES |
||
|
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
|
colorGroup1 | banding color of group 1. |
4078 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_BANDING_COLOR_GROUP1 |
|
|
colorGroup2 | banding color of group 2. |
4079 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_BANDING_COLOR_GROUP2 |
|
|
enabled | boolean property to specify, if the event should do a check for user autostyle preference and apply if there's one. |
4074 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_INCLUDE_USER_STYLE |
|
|
gridLevel | level of the grid unit when saving
the grid properties. The possible values are: 1 - Grid 2 - Header 3 - Subtotal grid 4 - Subtotal header |
4109 | ||
|
gridUnit | unit of the grid. The possible
values are: 1 - Template Unit 2 - Template Metric 3 - Rows 4 - Cols |
4108 | ||
|
group1 | banding group 1. |
4076 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_BANDING_GROUP1 |
|
|
group2 | banding group 2. |
4077 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_BANDING_GROUP2 |
|
|
oAxis | origin axis. |
4006 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_AXIS |
|
|
oPos | origin position of the template unit. |
4007 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_POSITION |
|
|
rowsColumns | specifies whether banding is on rows or columns. |
4075 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_BANDING_ROWSCOLS |
|
|
styleName | String argument specifying the name of the style to apply. |
4126 | ||
| saveGridBorderProperties | ||||
| Event for saving the grid border properties. |
4022 |
EnumReportBeanEvents.REPORT_EVENT_SAVE_GRID_BORDER_PROPERTIES |
||
|
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
|
bottomColor | bottom border color. |
4069 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_BORDER_BOTTOM_COLOR |
|
|
bottomStyle | bottom border style. |
4063 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_BORDER_BOTTOM_STYLE |
|
|
gridLevel | level of the grid unit when saving
the grid properties. The possible values are: 1 - Grid 2 - Header 3 - Subtotal grid 4 - Subtotal header |
4109 | ||
|
gridUnit | unit of the grid. The possible
values are: 1 - Template Unit 2 - Template Metric 3 - Rows 4 - Cols |
4108 | ||
|
hInsideColor | horizontal inside border color. |
4065 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_BORDER_HINSIDE_COLOR |
|
|
hInsideStyle | horizontal inside border style. |
4059 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_BORDER_HINSIDE_STYLE |
|
|
leftColor | left border color. |
4068 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_BORDER_LEFT_COLOR |
|
|
leftStyle | left border style. |
4062 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_BORDER_LEFT_STYLE |
|
|
oAxis | origin axis. |
4006 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_AXIS |
|
|
oPos | origin position of the template unit. |
4007 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_POSITION |
|
|
rightColor | right border color. |
4070 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_BORDER_RIGHT_COLOR |
|
|
rightStyle | right border style. |
4064 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_BORDER_RIGHT_STYLE |
|
|
styleName | String argument specifying the name of the style to apply. |
4126 | ||
|
topColor | top border color. |
4067 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_BORDER_TOP_COLOR |
|
|
topStyle | top border style. |
4061 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_BORDER_TOP_STYLE |
|
|
vInsideColor | vertical inside border color. |
4066 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_BORDER_VINSIDE_COLOR |
|
|
vInsideStyle | vertical inside border style. |
4060 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_BORDER_VINSIDE_STYLE |
|
| saveGridFontPropertiesEvent | ||||
| Event for saving the grid font properties. |
4018 | |||
|
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
|
fontBold | specifies whether the font is bold. |
4043 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_FONT_BOLD |
|
|
fontColor | color of the font. |
4048 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_FONT_COLOR |
|
|
fontItalic | specifies whether the font is italic. |
4044 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_FONT_ITALIC |
|
|
fontName | name of the font. |
4042 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_FONT_NAME |
|
|
fontScript | script of the font. |
4049 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_FONT_SCRIPT |
|
|
fontSize | size of the font. |
4045 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_FONT_SIZE |
|
|
fontStrikeout | specifies whether the font is strikedout. |
4046 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_FONT_STRIKEOUT |
|
|
fontUnderline | specifies whether the font is underlined. |
4047 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_FONT_UNDERLINE |
|
|
gridLevel | level of the grid unit when saving
the grid properties. The possible values are: 1 - Grid 2 - Header 3 - Subtotal grid 4 - Subtotal header |
4109 | ||
|
gridUnit | unit of the grid. The possible
values are: 1 - Template Unit 2 - Template Metric 3 - Rows 4 - Cols |
4108 | ||
|
oAxis | origin axis. |
4006 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_AXIS |
|
|
oPos | origin position of the template unit. |
4007 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_POSITION |
|
|
styleName | String argument specifying the name of the style to apply. |
4126 | ||
| saveGridNumberPropertiesEvent | ||||
| Event for saving the grid number properties. The possible arguments are: |
4020 |
EnumReportBeanEvents.REPORT_EVENT_SAVE_GRID_NUMBER_PROPERTIES |
||
|
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
|
category | number category. |
4050 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_NUM_CATEGORY |
|
|
currencyPosition | currency position. |
4054 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_NUM_CURRENCY_POS |
|
|
currencySymbol | currency symbol. |
4053 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_NUM_CURRENCY_SYMBOL |
|
|
decimalPlaces | decimal places of the number. |
4051 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_NUM_DECIMAL_PLACES |
|
|
format | number format. |
4055 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_NUM_FORMAT |
|
|
gridLevel | level of the grid unit when saving
the grid properties. The possible values are: 1 - Grid 2 - Header 3 - Subtotal grid 4 - Subtotal header |
4109 | ||
|
gridUnit | unit of the grid. The possible
values are: 1 - Template Unit 2 - Template Metric 3 - Rows 4 - Cols |
4108 | ||
|
negativeNumbers | currency position. |
4111 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_NUM_NEGATIVE_NUMS |
|
|
oAxis | origin axis. |
4006 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_AXIS |
|
|
oPos | origin position of the template unit. |
4007 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_POSITION |
|
|
styleName | String argument specifying the name of the style to apply. |
4126 | ||
|
thousandSeparator | thousand separator. |
4052 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_NUM_THOUSAND_SEP |
|
| saveGridPatternProperties | ||||
| Event for saving the grid pattern properties. |
4023 |
EnumReportBeanEvents.REPORT_EVENT_SAVE_GRID_PATTERN_PROPERTIES |
||
|
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
|
fillColor | pattern fill color. |
4071 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_PATTERN_FILL_COLOR |
|
|
gridLevel | level of the grid unit when saving
the grid properties. The possible values are: 1 - Grid 2 - Header 3 - Subtotal grid 4 - Subtotal header |
4109 | ||
|
gridUnit | unit of the grid. The possible
values are: 1 - Template Unit 2 - Template Metric 3 - Rows 4 - Cols |
4108 | ||
|
oAxis | origin axis. |
4006 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_AXIS |
|
|
oPos | origin position of the template unit. |
4007 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_POSITION |
|
|
patternColor | pattern color. |
4072 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_PATTERN_COLOR |
|
|
patternStyle | pattern style. |
4073 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRIDPROPS_PATTERN_STYLE |
|
|
styleName | String argument specifying the name of the style to apply. |
4126 | ||
| savePrintSubscriptionEvent | ||||
| Specifies an event to print subscription. |
4071 | |||
|
*triggerID | String argument indicating the trigger to be used. |
4127 | ||
|
addressValues | String argument indicating the physical addresses to be used for subscription. |
4130 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_VALUES |
|
|
cmsg | Message to be saved along with the email subscription |
4150 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_CUSTOM_MESSAGE |
|
|
copies | Specifies an argument for the number of copies. |
4182 | ||
|
fModeExAll | Denotes whether the only the current page (value of "0"), or all pages is applied to the subscription (value of "1"). |
4194 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_CONTENT_FORMAT_MODE_ALL_PAGES |
|
|
fModeSep | Denotes whether multiple pages should be separated (value of "1") on different worksheets - currently only applicable to Excel exports. |
4208 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_CONTENT_FORMAT_MODE_SEPARATED_PAGES |
|
|
fstate | The serialized state of the delivery format |
4151 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_FORMAT_STATE |
|
|
isCollated | Specifies an argument indicating whether it is collated in printer. |
4184 | ||
|
isPortrait | Specifies an argument indicating whether it is a portait in printer. |
4183 | ||
|
locKey | location key for scheduled file and print export |
4180 | ||
|
notifyAddressID | Subscription notification is sent to this existing address. |
4176 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_ID |
|
|
notifyAddressValue | Subscription notification is sent to this new address. If this is supplied, it
takes precedence over
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_ID. |
4177 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_VALUE |
|
|
notifyDeviceID | Specifies an event argument for subscription notification device id. |
4178 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_DEVICE_ID |
|
|
printAll | Specifies an event argument for subscription print all. |
4179 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_PRINT_ALL |
|
|
rangeEnd | Specifies an argument for range end in printing. |
4186 | ||
|
rangeStart | Specifies an argument for range start in printing. |
4185 | ||
|
sendNow | String argument indicating sendnow property for subscription. |
4133 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SUBSCRIPTION_SEND_NOW |
|
| saveScheduleEvent | ||||
Event for saving a web schedule. The caller has to specify a valid triggerID
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SCHEDULE_OVERWRITE argument is set to 0
and the EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SCHEDULE_REUSE_MESSAGE argument is set to 0 |
4043 | |||
|
*triggerID | String argument indicating the trigger to be used. |
4127 | ||
|
mobile |
5120016 | |||
|
overWrite | Argument specifying whether to overwrite an existing schedule during schedule. A value of 1 indicates that it should be overwritten. |
4148 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SCHEDULE_OVERWRITE |
|
|
reuseMsg | integer argument indicating whether the message should be reused while scheduling 1 indicates that it should be reused. |
4128 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SCHEDULE_REUSE_MESSAGE |
|
| saveToInbox | ||||
| Event for saving the report to Inbox. |
4030 | |||
| setColumnScenario | ||||
Event for setting the column scenario. If the scenario is set to EnumDSSXMLWidthScenario.DssXmlWidthFixed,
default grid and header widths should be specified too. |
4055 | |||
|
*columnScenario | Argument specifying the column scenario to be set. Possible values are listed in EnumDSSXMLWidthScenario |
4153 | ||
|
clearAllWidths | Argument specifying whether to clear all the widths before setting a column scenario
to EnumDSSXMLWidthScenario.DssXmlWidthFixed |
4161 | ||
|
gridWidth | Argument specifying the default grid width for a column scenario of type EnumDSSXMLWidthScenario.DssXmlWidthFixed |
4156 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DEFAULT_GRID_WIDTH |
|
|
headerWidth | Argument specifying the default header width for a column scenario of type EnumDSSXMLWidthScenario.DssXmlWidthFixed |
4155 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DEFAULT_HEADER_WIDTH |
|
| setCubeMapping | ||||
| Specifies an event to set the cube mapping. |
4080 | |||
|
cubeMapping | Cube mapping. |
4233 | ||
| setPageByElement | ||||
| Event for setting the current element in the page by axis. |
4008 | |||
|
*pageByKey | key for setting the page-by element.
The format of the key is a list of one or more position + elementID pairs:
positionEnumReportBeanEvents.PAGE_BY_KEY_SEPARATORelementID
(EnumReportBeanEvents.PAGE_BY_KEY_SEPARATORpositionEnumReportBeanEvents.PAGE_BY_KEY_SEPARATORelementID)* |
4017 | ||
|
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
|
elemStat | Argument indicating the status of the selected element.
This is a value from EnumDSSXMLCurrentElementStatus. |
4144 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_CURRENT_ELEMENT_STATUS |
|
| setReportPageInfo | ||||
| Sets the report page info on the Report Bean. It also saves the resulting window properties to IServer, if specified. |
4049 | |||
|
*columnsPerPage | argument indicating the columns per page desired for a report page info |
4140 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_REPORT_PAGE_INFO_COLUMNS_PER_PAGE |
|
|
*pageInfoType | argument indicating the type of report page info. Absolute or Relative.
Possible values are listed in EnumReportPageType |
4139 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_REPORT_PAGE_INFO_TYPE |
|
|
*rowsPerPage | Argument indicating the rows per page desired for a report page info |
4141 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_REPORT_PAGE_INFO_ROWS_PER_PAGE |
|
|
saveProperties | During setting report page info, if this argument is set to true, the resulting window properties are saved on IServer. |
4149 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_REPORT_PAGE_INFO_SAVE_PROPERTIES |
|
|
xPos | Argument indicating the X Position of the desired page on a report |
4142 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_REPORT_PAGE_INFO_XPOS |
|
|
yPos | Argument indicating the Y Position of the desired page on a report |
4143 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_REPORT_PAGE_INFO_YPOS |
|
| setReportProps | ||||
Event for setting values for specific properties
The argument needed for this event is EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SET_PROPERTY_VALUE |
4052 | |||
|
*propStr | Argument specifying the propertySet, the property name and the desired property
value that needs to be set.
The format of the argument is
ReportObjectType|sep|PropertySetName|sep|PropertyName|sep|PropertyValue
Where ReportObjectType is one value from the enumeration EnumDSSXMLReportObjects
and |sep| is a separator, the constant for which is EnumReportBeanEvents.REPORT_PROPERTY_LIST_SEPARATOR |
4146 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_SET_PROPERTY_VALUE |
|
|
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
|
styleName | String argument specifying the name of the style to apply. |
4126 | ||
| setResultSettings | ||||
| Specifies an event to set the report result settings. |
4079 | |||
|
ondemandDrillMinimalXML |
4230 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_ONDEMAND_DRILL_MINIMAL_XML |
||
|
resultFlags | result flags. |
4003 | ||
| setResultWindow | ||||
| Event for setting the limits of the result window. The grid/graph start/max rows/columns can be set |
4009 | |||
|
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
|
graphMaxCols | max number of columns for the grid. |
4025 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPH_MAX_COLUMNS |
|
|
graphMaxRows | max number of rows for the grid. |
4024 | ||
|
graphStartCol | start column of the grid. |
4023 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRAPH_START_COLUMN |
|
|
graphStartRow | start row of the grid. |
4022 | ||
|
gridMaxCols | max number of columns for the grid. |
4021 | ||
|
gridMaxRows | max number of rows for the grid. |
4020 | ||
|
gridStartCol | start column of the grid. |
4019 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_GRID_START_COLUMN |
|
|
gridStartRow | start row of the grid. |
4018 | ||
| setRowScenario | ||||
Event for setting the row scenario. If the row scenario is set to EnumDSSXMLWidthScenario.DssXmlWidthFixed,
row height should be specified too. |
4056 | |||
|
*rowScenario | Argument specifying the row scenario to be set. Possible values are EnumDSSXMLWidthScenario.DssXmlWidthFitToContent
and EnumDSSXMLWidthScenario.DssXmlWidthFixed |
4154 | ||
|
rowHeight | Argument specifying the row height for a row scenario of type EnumDSSXMLWidthScenario.DssXmlWidthFitToContent |
4157 | ||
| setViewMediaSettings | ||||
| Event for changing the view media settings |
4078 | |||
|
*availableModes |
4228 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_AVAILABLE_VIEW_MODES |
||
|
*defaultMode |
4229 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_DEFAULT_VIEW_MODE |
||
|
addViewMode | An integer that represents the view modes to add to the available view media property |
4243 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_ADD_AVAILABLE_VIEW_MODES |
|
|
removeViewMode | An integer that represents the view modes to remove from the available view media property |
4244 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_REMOVE_AVAILABLE_VIEW_MODES |
|
| showBandingEvent | ||||
| Event for showing or hiding the banding. |
4041 | |||
|
showBanding | boolean argument indicating whether banding should be shown.
a value of EnumReportBeanEvents.HIDE_BANDING indicates that banding should be hidden.
otherwise it is shown |
4125 | ||
|
styleName | String argument specifying the name of the style to apply. |
4126 | ||
| showOutlineMode | ||||
| Sets the flag that specifies whether the report should be displayed as outline mode or not. |
4034 | |||
|
outlineMode | String argument specifying whether the report should
be displayed in outline mode.
possible values are:
EnumReportBeanEvents.HIDE_OUTLINE_MODE
EnumReportBeanEvents.SHOW_OUTLINE_MODE |
4121 | ||
| showSubtotals | ||||
| Sets the flag that shows subtotals on the template. |
4032 | |||
|
show | boolean argument indicating whether subtotals should be shown.
possible values are:
EnumReportBeanEvents.SHOW_SUB_TOTALS
EnumReportBeanEvents.HIDE_SUB_TOTALS |
4116 | ||
| thresholdDisplay | ||||
| Event for enabling/disabling the thresholds correponding to metrics. |
4066 | |||
|
*enable | Specifies an argument for enabling display of threshold. |
4193 |
EnumReportBeanEvents.REPORT_EVENT_ARGUMENT_ENABLE_THRESHOLD_DISPLAY |
|
|
applyNow | specifies if the user wants to apply the changes by contacting the server. The allowed values are "true" or "false". The default value if "true" |
4110 | ||
| undo | ||||
| Event for undo current report to previous state. |
4065 | |||
| unsetDatamart | ||||
| This event would convert a report to datamart.
The possible parameters that can be sent in are:
|
4073 | |||
Notes
* denotes required field.