com.microstrategy.web.beans.EnumReportBeanEvents |
This interface lists the IDs for the events and the IDs for the corresponding arguments
for the events supported by the ReportBean
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | DRILL_IMPORTANCE_HIGH | Specifies an constant for drill importance high. | |||||||||
int | DRILL_IMPORTANCE_LOW | Specifies an constant for drill importance low. | |||||||||
int | DRILL_IMPORTANCE_MEDIUM | Specifies an constant for drill importance medium. | |||||||||
int | DRILL_RETAIN_PARENT | Constant specifying that the parent should be retained while drilling. | |||||||||
String | DRILL_TO_KEY_SEPARATOR | Specifies a separator for drill to key. | |||||||||
String | FORM_ELEM_SEPARATOR | Specifies a separator for form elements. | |||||||||
String | FORM_LIST_SEPARATOR | Specifies a separator for form list. | |||||||||
int | HIDE_BANDING | Constant specifying that banding should not be displayed. | |||||||||
int | HIDE_OUTLINE_MODE | Constant specifying that outline mode should not be displayed. | |||||||||
int | HIDE_SUB_TOTALS | Constant specifying that sutotals should not be shown. | |||||||||
String | METRIC_ELEM_LIST_SEPARATOR | Specifies a separator for metric element list. | |||||||||
String | MULTIPLE_UNITS_SEPARATOR | Separator between multiple report objects. | |||||||||
String | PAGE_BY_KEY_SEPARATOR | Specifies a separator for page-by key | |||||||||
int | REPORT_EVENT_ADD_BASE_UNIT | Specifies an event to add base unit. | |||||||||
int | REPORT_EVENT_ADD_DERIVED_METRIC | Event for adding a new derived metric to the metrics collection. | |||||||||
int | REPORT_EVENT_ADD_FORM | Event for adding attribute form. | |||||||||
int | REPORT_EVENT_ADD_METRIC | Adds the metric passed in with the specified key. | |||||||||
int | REPORT_EVENT_ADD_SHORTCUT_METRIC | Specifies an event to add shortcut metric. | |||||||||
int | REPORT_EVENT_ADD_TEMPLATE_UNIT | Event for adding a new template unit to the template. | |||||||||
int | REPORT_EVENT_APPLY_CHANGES | Event for applying the changes made on the report. | |||||||||
int | REPORT_EVENT_ARGUMENT_ADD_AVAILABLE_VIEW_MODES | An integer that represents the view modes to add to the available view media property | |||||||||
int | REPORT_EVENT_ARGUMENT_ALLOW_USER_SUBSCRIBE | allow users to subcribe a subscripiton 1 means allow, 0 means deny | |||||||||
int | REPORT_EVENT_ARGUMENT_APPLY_NOW | specifies if the user wants to apply the changes by contacting the server. | |||||||||
int | REPORT_EVENT_ARGUMENT_ATTRIBUTE_ID | Attribute ID | |||||||||
int | REPORT_EVENT_ARGUMENT_AUTOSIZE_HORIZONTAL | Specifies an argument for auto size horizontally. | |||||||||
int | REPORT_EVENT_ARGUMENT_AUTOSIZE_VERTICAL | Specifies an argument for auto size vertically. | |||||||||
int | REPORT_EVENT_ARGUMENT_AVAILABLE_VIEW_MODES | ||||||||||
int | REPORT_EVENT_ARGUMENT_CHANGE_STYLE_ID | style ID of the report. | |||||||||
int | REPORT_EVENT_ARGUMENT_CLEAR_ALL_WIDTHS | Argument specifying whether to clear all the widths before setting a column scenario
to DssXmlWidthFixed
|
|||||||||
int | REPORT_EVENT_ARGUMENT_COLUMN_IDENTIFIER | Argument specifying a column identifier. | |||||||||
int | REPORT_EVENT_ARGUMENT_COLUMN_SCENARIO | Argument specifying the column scenario to be set. | |||||||||
int | REPORT_EVENT_ARGUMENT_COPIES | Specifies an argument for the number of copies. | |||||||||
int | REPORT_EVENT_ARGUMENT_CUBE_ID | Specifies the DSSID of the cube report | |||||||||
int | REPORT_EVENT_ARGUMENT_CUBE_MAPPING | Cube mapping. | |||||||||
int | REPORT_EVENT_ARGUMENT_CURRENT_ELEMENT_STATUS | Argument indicating the status of the selected element. | |||||||||
int | REPORT_EVENT_ARGUMENT_DB_ROLE_ID | The DB Role ID. | |||||||||
int | REPORT_EVENT_ARGUMENT_DEFAULT_GRID_WIDTH | Argument specifying the default grid width for a column scenario of type DssXmlWidthFixed
|
|||||||||
int | REPORT_EVENT_ARGUMENT_DEFAULT_HEADER_WIDTH | Argument specifying the default header width for a column scenario of type DssXmlWidthFixed
|
|||||||||
int | REPORT_EVENT_ARGUMENT_DEFAULT_VIEW_MODE | ||||||||||
int | REPORT_EVENT_ARGUMENT_DISPLAY_FLAGS | SaveAs display flags. | |||||||||
int | REPORT_EVENT_ARGUMENT_DISPLAY_MODE | Specifies the display mode. | |||||||||
int | REPORT_EVENT_ARGUMENT_DM_APPEND | Datamart property that specifies whether to append to existing t able | |||||||||
int | REPORT_EVENT_ARGUMENT_DM_NAME_MACRO | Datamart property that specifies whether the datamart name speci fied has tokens or not. | |||||||||
int | REPORT_EVENT_ARGUMENT_DM_TABLE_NAME | The datamart table name | |||||||||
int | REPORT_EVENT_ARGUMENT_DO_NOT_UPDATE_CACHES | ||||||||||
int | REPORT_EVENT_ARGUMENT_DRILLTO_KEY | key for drilling. | |||||||||
int | REPORT_EVENT_ARGUMENT_DRILL_ELEMENT_LIST | list of elements. | |||||||||
int | REPORT_EVENT_ARGUMENT_DRILL_FILTER_ON_PAGE_BY | Argument specifying whether to filter on the Page By axis during drilling. | |||||||||
int | REPORT_EVENT_ARGUMENT_DRILL_FIX_TEMPLATE | flag to indicate a specific type of drilling to fix the template. | |||||||||
int | REPORT_EVENT_ARGUMENT_DRILL_GRAPH_XPIXEL | list of elements. | |||||||||
int | REPORT_EVENT_ARGUMENT_DRILL_GRAPH_YPIXEL | list of elements. | |||||||||
int | REPORT_EVENT_ARGUMENT_DRILL_IMPORTANCE | level of drill importance to retrieve. | |||||||||
int | REPORT_EVENT_ARGUMENT_DRILL_PATH_KEY | Specifies an argument for the drill path key. | |||||||||
int | REPORT_EVENT_ARGUMENT_DRILL_RETAIN_PARENT | specifies whether the parent should be kept after performing the drill operation. | |||||||||
int | REPORT_EVENT_ARGUMENT_DRILL_RETAIN_THRESHOLDS | specifies whether the thresholds should be kept after performing the drill operation. | |||||||||
int | REPORT_EVENT_ARGUMENT_ENABLE_THRESHOLD_DISPLAY | Specifies an argument for enabling display of threshold. | |||||||||
int | REPORT_EVENT_ARGUMENT_ENABLE_TOTALS | Specifies an argument for enabling totals. | |||||||||
int | REPORT_EVENT_ARGUMENT_EXECUTION_DUPLICATE_MESSAGE_ID | Specifies whether to duplicate the message passed. | |||||||||
int | REPORT_EVENT_ARGUMENT_EXECUTION_FILTER_ID | String argument specifying the filterID. | |||||||||
int | REPORT_EVENT_ARGUMENT_EXECUTION_FLAGS | flags to be used while performing report execution. | |||||||||
int | REPORT_EVENT_ARGUMENT_EXECUTION_MESSAGE_ID | String argument specifying the message ID of the report. | |||||||||
int | REPORT_EVENT_ARGUMENT_EXECUTION_STATE_ID | state ID of the report. | |||||||||
int | REPORT_EVENT_ARGUMENT_EXECUTION_TEMPLATE_ID | String argument specifying the templateID. | |||||||||
int | REPORT_EVENT_ARGUMENT_FILE_NAME | file name for scheduled file export | |||||||||
int | REPORT_EVENT_ARGUMENT_FORM_ID | DSSID of the form to be added/removed. | |||||||||
int | REPORT_EVENT_ARGUMENT_FORM_LIST | 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. | |||||||||
int | REPORT_EVENT_ARGUMENT_FORM_POSITION | the position within the attribute forms collection where a form should be added/moved. | |||||||||
int | REPORT_EVENT_ARGUMENT_FUNCTION_TYPE | Add shortcut Metric. | |||||||||
int | REPORT_EVENT_ARGUMENT_FUNCTION_TYPE2 | ||||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_ATTRIBUTEID | specifies an attribute in the graph. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_CONTENT | content of the graph object. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_FILL_COLOR | Specifies the fill color in the graph | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_FONT_ALIGN | font align property of the graph object. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_FONT_COLOR | font color property of the graph object. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_FONT_NAME | font name property of the graph object. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_FONT_SIZE | font size property of the graph object. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_FONT_STYLE | font style property of the graph object. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_HEIGHT | height of the graph. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_LINE_COLOR | Specifies the line color in the graph | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_MAJORTYPE | major type of the graph. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_MINORTYPE | minor type of the graph. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_OBJECTID | specifies an object in the graph. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_SCALEX | scale of the X axis. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_SCALEY1 | scale of the Y1 axis. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_SCALEY2 | scale of the Y2 axis. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_SCALEZ | scale of the Z axis. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_SERIESID | specifies a series in the graph. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_SHOW | show property of the graph object. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_SHOW2DOLABEL | specifies whether to show the 2DO Label. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_SHOW2DXVALUE | specifies whether to show the 2DX value. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_SHOW2DY1VALUE | specifies whether to show the 2DY1 value. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_SHOW2DY2VALUE | specifies whether to show the 2DY2 value. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_SHOW3DCHEADER | specifies whether to show the 3DC header. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_SHOW3DLNUMBER | specifies whether to show the 3DL number. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_SHOW3DRHEADER | specifies whether to show the 3DR header. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_SHOW3DRNUMBER | specifies whether to show the 3DR number. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_STEPX | step of the X axis. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_STEPY1 | step of the Y1 axis. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_STEPY2 | step of the Y2 axis. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_STEPZ | step of the Z axis. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_VALUE | specifies a graph property value. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPHPROPS_WIDTH | width of the graph. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPH_MAX_COLUMNS | max number of columns for the grid. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPH_MAX_ROWS | max number of rows for the grid. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPH_START_COLUMN | start column of the grid. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRAPH_START_ROW | start row of the grid. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_ALIGNMENT_HORIZONTAL | specifies horizontal alignment. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_ALIGNMENT_VERTICAL | specifies vertical alignment. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_ALIGNMENT_WRAP | specifies text wrap. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_BANDING_COLOR_GROUP1 | banding color of group 1. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_BANDING_COLOR_GROUP2 | banding color of group 2. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_BANDING_ENABLED | specifies that banding is enabled. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_BANDING_GROUP1 | banding group 1. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_BANDING_GROUP2 | banding group 2. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_BANDING_ROWSCOLS | specifies whether banding is on rows or columns. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_BORDER_BOTTOM_COLOR | bottom border color. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_BORDER_BOTTOM_STYLE | bottom border style. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_BORDER_HINSIDE_COLOR | horizontal inside border color. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_BORDER_HINSIDE_STYLE | horizontal inside border style. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_BORDER_LEFT_COLOR | left border color. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_BORDER_LEFT_STYLE | left border style. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_BORDER_RIGHT_COLOR | right border color. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_BORDER_RIGHT_STYLE | right border style. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_BORDER_TOP_COLOR | top border color. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_BORDER_TOP_STYLE | top border style. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_BORDER_VINSIDE_COLOR | vertical inside border color. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_BORDER_VINSIDE_STYLE | vertical inside border style. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_FONT_BOLD | specifies whether the font is bold. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_FONT_COLOR | color of the font. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_FONT_ITALIC | specifies whether the font is italic. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_FONT_NAME | name of the font. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_FONT_SCRIPT | script of the font. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_FONT_SIZE | size of the font. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_FONT_STRIKEOUT | specifies whether the font is strikedout. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_FONT_UNDERLINE | specifies whether the font is underlined. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_LEVEL | level of the grid unit when saving the grid properties. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_NUM_CATEGORY | number category. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_NUM_CURRENCY_POS | currency position. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_NUM_CURRENCY_SYMBOL | currency symbol. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_NUM_DECIMAL_PLACES | decimal places of the number. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_NUM_FORMAT | number format. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_NUM_NEGATIVE_NUMS | currency position. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_NUM_THOUSAND_SEP | thousand separator. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_PATTERN_COLOR | pattern color. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_PATTERN_FILL_COLOR | pattern fill color. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_PATTERN_STYLE | pattern style. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRIDPROPS_UNIT | unit of the grid. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRID_MAX_COLUMNS | max number of columns for the grid. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRID_MAX_ROWS | max number of rows for the grid. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRID_START_COLUMN | start column of the grid. | |||||||||
int | REPORT_EVENT_ARGUMENT_GRID_START_ROW | start row of the grid. | |||||||||
int | REPORT_EVENT_ARGUMENT_INCLUDE_USER_STYLE | boolean property to specify, if the event should do a check for user autostyle preference and apply if there's one. | |||||||||
int | REPORT_EVENT_ARGUMENT_IS_BASE | specifies whether the add/remove form operation should be applied to the working set. | |||||||||
int | REPORT_EVENT_ARGUMENT_IS_COLLATED | Specifies an argument indicating whether it is collated in printer. | |||||||||
int | REPORT_EVENT_ARGUMENT_IS_PORTRAIT | Specifies an argument indicating whether it is a portait in printer. | |||||||||
int | REPORT_EVENT_ARGUMENT_LINK_ANSWERS | ||||||||||
int | REPORT_EVENT_ARGUMENT_LOCATION_KEY | location key for scheduled file and print export | |||||||||
int | REPORT_EVENT_ARGUMENT_MAX_WAIT | Specifies an argument for max wait in report execution. | |||||||||
int | REPORT_EVENT_ARGUMENT_MESSAGE_ID | String argument specifying the message id of a report instance. | |||||||||
int | REPORT_EVENT_ARGUMENT_METRIC_ALIAS_NAME | alias for a metric. | |||||||||
int | REPORT_EVENT_ARGUMENT_METRIC_DESTINATION_POSITION | destination position of the metric in the metrics collection. | |||||||||
int | REPORT_EVENT_ARGUMENT_METRIC_FORMULA | formula for a derived metric. | |||||||||
int | REPORT_EVENT_ARGUMENT_METRIC_ID | String argument specifying the id of the metric. | |||||||||
int | REPORT_EVENT_ARGUMENT_METRIC_KEY | key of a specific metric in the collection. | |||||||||
int | REPORT_EVENT_ARGUMENT_METRIC_NAME | name of the metric | |||||||||
int | REPORT_EVENT_ARGUMENT_METRIC_ORIGIN_POSITION | starting position of the metric in the metrics collection. | |||||||||
int | REPORT_EVENT_ARGUMENT_MOBILE | ||||||||||
int | REPORT_EVENT_ARGUMENT_MULTIPLE_UNITS | 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 UNIT_PROPERTY_SEPARATOR and MULTIPLE_UNITS_SEPARATOR . |
|||||||||
int | REPORT_EVENT_ARGUMENT_NEW_COLUMN_SIZE | Argument specifying the new column size for a column resize request. | |||||||||
int | REPORT_EVENT_ARGUMENT_NODE_KEY | Specifies the node key of the grid-graph object in the doccument | |||||||||
int | REPORT_EVENT_ARGUMENT_NON_SCHEDULABLE | ||||||||||
int | REPORT_EVENT_ARGUMENT_ONDEMAND_DRILL_MINIMAL_XML | ||||||||||
int | REPORT_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID | Specifies an argument for the original report message id in document drilling. | |||||||||
int | REPORT_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML | Specifies an argument for the original report's prompt answer XML in document drilling. | |||||||||
int | REPORT_EVENT_ARGUMENT_OUTLINE_LEVEL | Specifies the outline level. | |||||||||
int | REPORT_EVENT_ARGUMENT_OUTLINE_MODE | String argument specifying whether the report should be displayed in outline mode. | |||||||||
int | REPORT_EVENT_ARGUMENT_PAGE_BY_KEY | key for setting the page-by element. | |||||||||
int | REPORT_EVENT_ARGUMENT_PAGE_BY_NAVIGATION_DIRECTION | String argument specifying whether to move to the next page or the previous page. | |||||||||
int | REPORT_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER | Specifies an argument for the new prompt answer for
WebElementsPrompt in
document drilling. |
|||||||||
int | REPORT_EVENT_ARGUMENT_PLAIN_OBJECT_PROMPT_ANSWER | Specifies an argument for the new prompt answer for
WebObjectsPrompt in
document drilling. |
|||||||||
int | REPORT_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER | Specifies an argument for the new prompt answer for
WebConstantPrompt in
document drilling. |
|||||||||
int | REPORT_EVENT_ARGUMENT_PROMPT_ANSWER_MODE_OPTION | An integer prompt answer mode from EnumWebPromptAnswerMode
|
|||||||||
int | REPORT_EVENT_ARGUMENT_RANGE_END | Specifies an argument for range end in printing. | |||||||||
int | REPORT_EVENT_ARGUMENT_RANGE_START | Specifies an argument for range start in printing. | |||||||||
int | REPORT_EVENT_ARGUMENT_REEXECUTE_FRESH | Argument indicating whether the report should be re-executed with fresh execution flags. | |||||||||
int | REPORT_EVENT_ARGUMENT_REMOVE_AVAILABLE_VIEW_MODES | An integer that represents the view modes to remove from the available view media property | |||||||||
int | REPORT_EVENT_ARGUMENT_REPORT_ID | display flag to be used while performing report execution. | |||||||||
int | REPORT_EVENT_ARGUMENT_REPORT_NAME | Specifies an argument for report name. | |||||||||
int | REPORT_EVENT_ARGUMENT_REPORT_PAGE_INFO_COLUMNS_PER_PAGE | argument indicating the columns per page desired for a report page info | |||||||||
int | REPORT_EVENT_ARGUMENT_REPORT_PAGE_INFO_ROWS_PER_PAGE | Argument indicating the rows per page desired for a report page info | |||||||||
int | REPORT_EVENT_ARGUMENT_REPORT_PAGE_INFO_SAVE_PROPERTIES | During setting report page info, if this argument is set to true, the resulting window properties are saved on IServer. | |||||||||
int | REPORT_EVENT_ARGUMENT_REPORT_PAGE_INFO_TYPE | argument indicating the type of report page info. | |||||||||
int | REPORT_EVENT_ARGUMENT_REPORT_PAGE_INFO_XPOS | Argument indicating the X Position of the desired page on a report | |||||||||
int | REPORT_EVENT_ARGUMENT_REPORT_PAGE_INFO_YPOS | Argument indicating the Y Position of the desired page on a report | |||||||||
int | REPORT_EVENT_ARGUMENT_REPROMPT | rePrompting option for refreshing a report. | |||||||||
int | REPORT_EVENT_ARGUMENT_RESIZE_REQUESTS | Argument specifying the resize requests for column resizing. | |||||||||
int | REPORT_EVENT_ARGUMENT_RESULT_FLAGS | result flags. | |||||||||
int | REPORT_EVENT_ARGUMENT_ROW_HEIGHT | Argument specifying the row height for a row scenario of type DssXmlWidthFitToContent
|
|||||||||
int | REPORT_EVENT_ARGUMENT_ROW_SCENARIO | Argument specifying the row scenario to be set. | |||||||||
int | REPORT_EVENT_ARGUMENT_RW_GROUP_BY_ELEMENTS | Specifies the page by elements on the report writing document for the grid graph object that was drilled on. | |||||||||
int | REPORT_EVENT_ARGUMENT_SAVE_AS_DESCRIPTION | SaveAs report description. | |||||||||
int | REPORT_EVENT_ARGUMENT_SAVE_AS_FLAGS | save as flags. | |||||||||
int | REPORT_EVENT_ARGUMENT_SAVE_AS_NAME | SaveAs report name. | |||||||||
int | REPORT_EVENT_ARGUMENT_SAVE_AS_PARENT_FOLDER_ID | SaveAs parent folder. | |||||||||
int | REPORT_EVENT_ARGUMENT_SAVE_TO_INBOX | Specifies whether to save the message to inbox. | |||||||||
int | REPORT_EVENT_ARGUMENT_SCHEDULE_LIST | ||||||||||
int | REPORT_EVENT_ARGUMENT_SCHEDULE_OVERWRITE | Argument specifying whether to overwrite an existing schedule during schedule. | |||||||||
int | REPORT_EVENT_ARGUMENT_SCHEDULE_REUSE_MESSAGE | integer argument indicating whether the message should be reused while scheduling 1 indicates that it should be reused. |
|||||||||
int | REPORT_EVENT_ARGUMENT_SERIES_BY_COLUMNS | Specifies an argument for graph series. | |||||||||
int | REPORT_EVENT_ARGUMENT_SET_PROPERTY_VALUE | Argument specifying the propertySet, the property name and the desired property value that needs to be set. | |||||||||
int | REPORT_EVENT_ARGUMENT_SHOW_BANDING | boolean argument indicating whether banding should be shown. | |||||||||
int | REPORT_EVENT_ARGUMENT_SHOW_SUBTOTALS | boolean argument indicating whether subtotals should be shown. | |||||||||
int | REPORT_EVENT_ARGUMENT_SLICE_ID | ||||||||||
int | REPORT_EVENT_ARGUMENT_SORTS_COUNT | number of sorts that should be applied to the report. | |||||||||
int | REPORT_EVENT_ARGUMENT_SORT_CLEAR | specifies whether the previous sorts should be cleared before adding the current ones. | |||||||||
int | REPORT_EVENT_ARGUMENT_SORT_KEY | sort key. | |||||||||
int | REPORT_EVENT_ARGUMENT_SORT_ORDER | order of the sort -- SORT_ORDER_ASCENDING /SORT_ORDER_DESCENDING . |
|||||||||
int | REPORT_EVENT_ARGUMENT_SORT_SUBTOTAL_POSITION | argument indicating where the subtotals should be placed once the sorting is performed. | |||||||||
int | REPORT_EVENT_ARGUMENT_SRC_ANSWERS | ||||||||||
int | REPORT_EVENT_ARGUMENT_STATE_ID | state id of a report instance. | |||||||||
int | REPORT_EVENT_ARGUMENT_STYLE_NAME | String argument specifying the name of the style to apply. | |||||||||
int | REPORT_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_ID | String argument indicating the address ID. | |||||||||
int | REPORT_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_VALUES | String argument indicating the physical addresses to be used for subscription. | |||||||||
int | REPORT_EVENT_ARGUMENT_SUBSCRIPTION_CONTENT_FORMAT_MODE |
This constant is deprecated.
replaced by REPORT_EVENT_ARGUMENT_SUBSCRIPTION_CONTENT_FORMAT_MODE_ALL_PAGES |
|||||||||
int | REPORT_EVENT_ARGUMENT_SUBSCRIPTION_CONTENT_FORMAT_MODE_ALL_PAGES | Denotes whether the only the current page (value of "0"), or all pages is applied to the subscription (value of "1"). | |||||||||
int | REPORT_EVENT_ARGUMENT_SUBSCRIPTION_CONTENT_FORMAT_MODE_SEPARATED_PAGES | Denotes whether multiple pages should be separated (value of "1") on different worksheets - currently only applicable to Excel exports. | |||||||||
int | REPORT_EVENT_ARGUMENT_SUBSCRIPTION_CUSTOM_MESSAGE | Message to be saved along with the email subscription | |||||||||
int | REPORT_EVENT_ARGUMENT_SUBSCRIPTION_DEVICE_ID | String argument indicating the deviceID. | |||||||||
int | REPORT_EVENT_ARGUMENT_SUBSCRIPTION_EMAIL_SUBJECT | String argument indicating the email subject to be used for subscription. | |||||||||
int | REPORT_EVENT_ARGUMENT_SUBSCRIPTION_FORMAT_STATE | The serialized state of the delivery format | |||||||||
int | REPORT_EVENT_ARGUMENT_SUBSCRIPTION_ID | Argument indicating the target object to be used to initialize the report bean using a subscription. | |||||||||
int | REPORT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_ID | Subscription notification is sent to this existing address. | |||||||||
int | REPORT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_VALUE | Subscription notification is sent to this new address. | |||||||||
int | REPORT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_DEVICE_ID | Specifies an event argument for subscription notification device id. | |||||||||
int | REPORT_EVENT_ARGUMENT_SUBSCRIPTION_PRINT_ALL | Specifies an event argument for subscription print all. | |||||||||
int | REPORT_EVENT_ARGUMENT_SUBSCRIPTION_SEND_NOW | String argument indicating sendnow property for subscription. | |||||||||
int | REPORT_EVENT_ARGUMENT_SUBSCRIPTION_ZIP_CONTENTS | Indicates whether the format should be zipped | |||||||||
int | REPORT_EVENT_ARGUMENT_SUBTOTAL_STYLE | subtotal style. | |||||||||
int | REPORT_EVENT_ARGUMENT_SUBTOTAL_TYPE | type of subtotal to be added/removed. | |||||||||
int | REPORT_EVENT_ARGUMENT_TARGET_ID | Argument indicating the target object to be used to initialize the report bean using a schedule. | |||||||||
int | REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_ALIAS_NAME | new alias of the template unit. | |||||||||
int | REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_AXIS | destination axis. | |||||||||
int | REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_POSITION | destination position of the template unit. | |||||||||
int | REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_ID | dss id of the template unit. | |||||||||
int | REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_KEY | key of the template unit. | |||||||||
int | REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_NAME | name of the object on this template unit | |||||||||
int | REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_AXIS | origin axis. | |||||||||
int | REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_ORIGIN_POSITION | origin position of the template unit. | |||||||||
int | REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_TYPE | type of template unit, as defined in EnumDSSXMLTemplateUnitType . |
|||||||||
int | REPORT_EVENT_ARGUMENT_TREE_TYPE | Specifies the tree type to which the grid-graph object in the doccument belongs to | |||||||||
int | REPORT_EVENT_ARGUMENT_TRIGGER_ID | String argument indicating the trigger to be used. | |||||||||
int | REPORT_EVENT_ARGUMENT_UNITS_COLLECTION | ||||||||||
int | REPORT_EVENT_ARGUMENT_USER_LIST | 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 | |||||||||
int | REPORT_EVENT_ARGUMENT_VIEW_MODE | integer argument of EnumWebReportViewMode specifying the report view mode. |
|||||||||
int | REPORT_EVENT_ARGUMENT_VISUALIZATION_MODE | Visualization mode. | |||||||||
int | REPORT_EVENT_ARGUMENT_WORKING_SET_OBJECT_ID | object ID to remove from the working set. | |||||||||
int | REPORT_EVENT_ARGUMENT_WORKING_SET_OBJECT_SUB_TYPE | Argument indicating the subtype of the object. | |||||||||
int | REPORT_EVENT_ARGUMENT_WORKING_SET_OBJECT_TYPE | object type to remove from the working set. | |||||||||
int | REPORT_EVENT_ARGUMENT_XDA_ID | Specifies the DSSID of the xda report | |||||||||
int | REPORT_EVENT_CANCEL_REPROMPT_REQUEST | Event for canceling a reprompt request. | |||||||||
int | REPORT_EVENT_CANCEL_REQUEST | Event for canceling the request. | |||||||||
int | REPORT_EVENT_CHANGE_METRIC_FORMULA | Event for changing the formula and/or alias associated with a metric. | |||||||||
int | REPORT_EVENT_CHANGE_STYLE | Event for changing the style of a report. | |||||||||
int | REPORT_EVENT_CHANGE_VIEW_MODE | Event for change report view mode to grid, graph or both. | |||||||||
int | REPORT_EVENT_CLEAR_PAGE_BY | Event for clearing the page by axis. | |||||||||
int | REPORT_EVENT_CLEAR_SORTS | Clears all the WebSorts objects contained in the report. | |||||||||
int | REPORT_EVENT_DEFINE_DATAMART | This event would convert a report to datamart. | |||||||||
int | REPORT_EVENT_DISABLE_SUB_TOTALS | Event for disabling either a specific type of subtotal. | |||||||||
int | REPORT_EVENT_DRILL_TO_FIXED_TEMPLATE_FROM_DOCUMENT_TO_REPORT | Event for performing a filter on selections on a grid in a document to the report outside of the document. | |||||||||
int | REPORT_EVENT_EDIT_ATTRIBUTE_FORMS | Event for editing attribute forms collection, includes adding/removing forms from base and view, reorder forms in view. | |||||||||
int | REPORT_EVENT_ENABLE_SUB_TOTALS | Event for enabling the subtotals of the specified type and style. | |||||||||
int | REPORT_EVENT_EXECUTE | Event for executing a report. | |||||||||
int | REPORT_EVENT_EXECUTE_TEMPLATE_FILTER | Sets the flags for execution based on templateID and filterID. | |||||||||
int | REPORT_EVENT_GRAPH_DRILL | Event for performing a drill on the report graph. | |||||||||
int | REPORT_EVENT_GRAPH_DRILL_FROM_DOCUMENT_TO_REPORT | Event for performing a drill on the graph in a document to the report outside of the document. | |||||||||
int | REPORT_EVENT_GRID_DRILL | Event for performing a drill on the report grid. | |||||||||
int | REPORT_EVENT_GRID_DRILL_FIX_TEMPLATE | Event for performing a drill with the template fixed. | |||||||||
int | REPORT_EVENT_GRID_DRILL_FROM_DOCUMENT_TO_REPORT | Event for performing a drill on the grid in a document to the report outside of the document. | |||||||||
int | REPORT_EVENT_HIERARCHICAL_METRIC_SORT | Event for applying hierarchical metric sort in outline mode. | |||||||||
int | REPORT_EVENT_INCREMENTAL_FETCH | Event for doing an incremental fetch on the report using its
ReportPageInfo . |
|||||||||
int | REPORT_EVENT_INITIALIZE_FROM_SCHEDULE |
This constant is deprecated.
Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions.
Please use REPORT_EVENT_INITIALIZE_FROM_SUBSCRIPTION instead.
|
|||||||||
int | REPORT_EVENT_INITIALIZE_FROM_SUBSCRIPTION | Event for initializing the report bean using a subscription. | |||||||||
int | REPORT_EVENT_MOVE_METRIC | Event for moving a metric within the metric collection. | |||||||||
int | REPORT_EVENT_MULTIPLE_SORTS | Event for setting multiple sort objects. | |||||||||
int | REPORT_EVENT_PAGE_BY_NAVIGATE | Event for navigate pages for the report page-by operation. | |||||||||
int | REPORT_EVENT_PIVOT | Event for performing pivot. | |||||||||
int | REPORT_EVENT_REDO | Event for redo current report to next state. | |||||||||
int | REPORT_EVENT_REFRESH | Event for refreshing a report. | |||||||||
int | REPORT_EVENT_REMOVE_ALL_WORKING_SET_METRICS | Specifies an event to remove all working set metrics. | |||||||||
int | REPORT_EVENT_REMOVE_FORM | Event for removing attribute form. | |||||||||
int | REPORT_EVENT_REMOVE_METRIC | Removes a metric based on the specified key or position. | |||||||||
int | REPORT_EVENT_REMOVE_MULTIPLE_UNITS_FROM_WORKING_SET | Event to remove multiple units at the same time. | |||||||||
int | REPORT_EVENT_REMOVE_TEMPLATE_UNIT | Event for removing a specific template unit from the report template. | |||||||||
int | REPORT_EVENT_REMOVE_WORKING_SET_OBJECT | Event for removing a unit from the working set. | |||||||||
int | REPORT_EVENT_RESET_CHANGES | Event for reseting the changes made on the report. | |||||||||
int | REPORT_EVENT_RESET_STATE | resets the stateID | |||||||||
int | REPORT_EVENT_RESIZE_COLUMN_WIDTH | Event for resizing the an individual column width or all columns. | |||||||||
int | REPORT_EVENT_RESIZE_COLUMN_WIDTHS | Event for resizing the column widths. | |||||||||
int | REPORT_EVENT_SAVE_AS | Event for saving a report back into metadata. | |||||||||
int | REPORT_EVENT_SAVE_ASSOCIATED_SCHEDULES | Specifies an event to save associated schedule. | |||||||||
int | REPORT_EVENT_SAVE_ASSOCIATED_USERS | Specifies an event to save associated users | |||||||||
int | REPORT_EVENT_SAVE_FILE_SUBSCRIPTION | Specifies an event to save subscription to a file. | |||||||||
int | REPORT_EVENT_SAVE_GRAPH_AXIS_PROPERTIES | Event for saving the graph axis properties. | |||||||||
int | REPORT_EVENT_SAVE_GRAPH_FORMAT_PROPERTIES | Event for saving graph format properties | |||||||||
int | REPORT_EVENT_SAVE_GRAPH_PROPERTIES | Event for saving the graph properties. | |||||||||
int | REPORT_EVENT_SAVE_GRAPH_TEXT_PROPERTIES |
This constant is deprecated.
Please use REPORT_EVENT_SAVE_GRAPH_FORMAT_PROPERTIES instead.
|
|||||||||
int | REPORT_EVENT_SAVE_GRID_ALIGNMENT_PROPERTIES | Event for saving the grid alignment properties. | |||||||||
int | REPORT_EVENT_SAVE_GRID_BANDING_PROPERTIES | Event for saving the grid banding properties. | |||||||||
int | REPORT_EVENT_SAVE_GRID_BORDER_PROPERTIES | Event for saving the grid border properties. | |||||||||
int | REPORT_EVENT_SAVE_GRID_FONT_PROPERTIES | Event for saving the grid font properties. | |||||||||
int | REPORT_EVENT_SAVE_GRID_NUMBER_PROPERTIES | Event for saving the grid number properties. | |||||||||
int | REPORT_EVENT_SAVE_GRID_PATTERN_PROPERTIES | Event for saving the grid pattern properties. | |||||||||
int | REPORT_EVENT_SAVE_PRINT_SUBSCRIPTION | Specifies an event to print subscription. | |||||||||
int | REPORT_EVENT_SAVE_SCHEDULE |
This constant is deprecated.
Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions.
Please use events defined on the SubscriptionBean instead
|
|||||||||
int | REPORT_EVENT_SAVE_SUBSCRIPTION | Event for saving an e-mail subscription. | |||||||||
int | REPORT_EVENT_SAVE_TO_INBOX | Event for saving the report to Inbox. | |||||||||
int | REPORT_EVENT_SET_COLUMN_SCENARIO | Event for setting the column scenario. | |||||||||
int | REPORT_EVENT_SET_CUBE_MAPPING | Specifies an event to set the cube mapping. | |||||||||
int | REPORT_EVENT_SET_PAGE_BY_ELEMENT | Event for setting the current element in the page by axis. | |||||||||
int | REPORT_EVENT_SET_PROPERTY_VALUES | Event for setting values for specific properties
The argument needed for this event is REPORT_EVENT_ARGUMENT_SET_PROPERTY_VALUE
|
|||||||||
int | REPORT_EVENT_SET_REPORT_PAGE_INFO | Sets the report page info on the Report Bean. | |||||||||
int | REPORT_EVENT_SET_RESULT_SETTINGS | Specifies an event to set the report result settings. | |||||||||
int | REPORT_EVENT_SET_RESULT_WINDOW | Event for setting the limits of the result window. | |||||||||
int | REPORT_EVENT_SET_ROW_SCENARIO | Event for setting the row scenario. | |||||||||
int | REPORT_EVENT_SET_THRESHOLDS_DISPLAY | Event for enabling/disabling the thresholds correponding to metrics. | |||||||||
int | REPORT_EVENT_SET_VIEW_MEDIA_SETTINGS | Event for changing the view media settings | |||||||||
int | REPORT_EVENT_SHOW_BANDING | Event for showing or hiding the banding. | |||||||||
int | REPORT_EVENT_SHOW_OUTLINE_MODE | Sets the flag that specifies whether the report should be displayed as outline mode or not. | |||||||||
int | REPORT_EVENT_SHOW_SUBTOTALS | Sets the flag that shows subtotals on the template. | |||||||||
int | REPORT_EVENT_SORT | Event for setting the sort object.Defines the sorts to be added. | |||||||||
int | REPORT_EVENT_TEMPLATE_UNIT_ALIAS | Event for specifying the alias of a template unit. | |||||||||
int | REPORT_EVENT_UNDO | Event for undo current report to previous state. | |||||||||
int | REPORT_EVENT_UNSET_DATAMART | This event would convert a report to datamart. | |||||||||
String | REPORT_PROPERTY_LIST_SEPARATOR | Specifies a separator for report property list. | |||||||||
int | SHOW_BANDING | Constant specifying that banding should be displayed. | |||||||||
int | SHOW_OUTLINE_MODE | Constant specifying that outline mode should be displayed. | |||||||||
int | SHOW_SUB_TOTALS | Constant specifying that sutotals should be shown. | |||||||||
String | SORT_ELEM_LIST_SEPARATOR | Specifies a separator for element list in sorting. | |||||||||
int | SORT_EVENT_SET_CLEAR | Constant specifying that the existing sorts on the template should first be cleared. | |||||||||
int | SORT_ORDER_ASCENDING | Constant specifying that the sort order should be ascending. | |||||||||
int | SORT_ORDER_DESCENDING | Constant specifying that the sort order should be descending. | |||||||||
String | SORT_PARAM_AXIS | Specifies a sorting parameter for sort axis. | |||||||||
String | SORT_PARAM_ELEM_LIST | Specifies a sorting parameter for element list. | |||||||||
String | SORT_PARAM_FORM_ID | Specifies a sorting parameter for sort form id. | |||||||||
String | SORT_PARAM_FORM_TYPE | Specifies a sorting parameter for sort form type. | |||||||||
String | SORT_PARAM_ID | Specifies a sorting parameter for sort id. | |||||||||
String | SORT_PARAM_SEPARATOR | Specifies a separator for sort. | |||||||||
String | SORT_PARAM_TYPE | Specifies a sorting parameter for sort type. | |||||||||
String | UNIT_PROPERTY_SEPARATOR | Separator between each property that is used to specify the report object. |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Specifies an constant for drill importance high.
Specifies an constant for drill importance low.
Specifies an constant for drill importance medium.
Constant specifying that the parent should be retained while drilling.
Specifies a separator for drill to key.
Specifies a separator for form elements.
Specifies a separator for form list.
Constant specifying that banding should not be displayed.
Constant specifying that outline mode should not be displayed.
Constant specifying that sutotals should not be shown.
Specifies a separator for metric element list.
Separator between multiple report objects. Used in the REPORT_EVENT_ARGUMENT_MULTIPLE_UNITS
argument
Specifies a separator for page-by key
Specifies an event to add base unit.
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 REPORT_EVENT_ARGUMENT_METRIC_DESTINATION_POSITION
is not specified, the metric
is added at position 1
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.
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 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 REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_DESTINATION_AXIS
and
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.
Specifies an event to add shortcut metric.
Event for adding a new template unit to the template.
Event for applying the changes made on the report.
An integer that represents the view modes to add to the available view media property
allow users to subcribe a subscripiton 1 means allow, 0 means deny
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"
Attribute ID
Specifies an argument for auto size horizontally.
Specifies an argument for auto size vertically.
style ID of the report.
Argument specifying whether to clear all the widths before setting a column scenario
to DssXmlWidthFixed
Argument specifying the column scenario to be set. Possible values are listed in EnumDSSXMLWidthScenario
Specifies an argument for the number of copies.
Specifies the DSSID of the cube report
Cube mapping.
Argument indicating the status of the selected element.
This is a value from EnumDSSXMLCurrentElementStatus
.
The DB Role ID.
Argument specifying the default grid width for a column scenario of type DssXmlWidthFixed
Argument specifying the default header width for a column scenario of type DssXmlWidthFixed
SaveAs display flags.
Specifies the display mode. A value from the enumeration EnumDSSXMLDisplayMode
Datamart property that specifies whether to append to existing t able
Datamart property that specifies whether the datamart name speci fied has tokens or not.
The datamart table name
key for drilling.
axis<separator>position<separator>ordinal<separator>drillPathID
The <separator> is DRILL_TO_KEY_SEPARATOR
list of elements.
This is a list of element IDs separated by METRIC_ELEM_LIST_SEPARATOR
Argument specifying whether to filter on the Page By axis during drilling.
flag to indicate a specific type of drilling to fix the template.
list of elements.
list of elements.
level of drill importance to retrieve.
possible values are:
DRILL_IMPORTANCE_LOW
DRILL_IMPORTANCE_MEDIUM
DRILL_IMPORTANCE_HIGH
Specifies an argument for the drill path key.
specifies whether the parent should be kept after performing the drill operation.
specifies whether the thresholds should be kept after performing the drill operation.
Specifies an argument for enabling display of threshold.
Specifies an argument for enabling totals.
Specifies whether to duplicate the message passed.
String argument specifying the filterID.
flags to be used while performing report execution.
String argument specifying the message ID of the report.
state ID of the report.
String argument specifying the templateID.
file name for scheduled file export
DSSID of the form to be added/removed.
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 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 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_IDFORM_ELEM_SEPARATOR
0FORM_LIST_SEPARATOR
form2_IDFORM_ELEM_SEPARATOR
1
the position within the attribute forms collection where a form should be added/moved.
Add shortcut Metric. REPORT_EVENT_ADD_SHORTCUT_METRIC
specifies an attribute in the graph.
content of the graph object.
Specifies the fill color in the graph
font align property of the graph object.
font color property of the graph object.
font name property of the graph object.
font size property of the graph object.
font style property of the graph object.
height of the graph.
Specifies the line color in the graph
major type of the graph.
minor type of the graph.
specifies an object in the graph.
scale of the X axis.
scale of the Y1 axis.
scale of the Y2 axis.
scale of the Z axis.
specifies a series in the graph.
show property of the graph object.
specifies whether to show the 2DO Label.
specifies whether to show the 2DX value.
specifies whether to show the 2DY1 value.
specifies whether to show the 2DY2 value.
specifies whether to show the 3DC header.
specifies whether to show the 3DL number.
specifies whether to show the 3DR header.
specifies whether to show the 3DR number.
step of the X axis.
step of the Y1 axis.
step of the Y2 axis.
step of the Z axis.
specifies a graph property value.
width of the graph.
max number of columns for the grid.
max number of rows for the grid.
start column of the grid.
start row of the grid.
specifies horizontal alignment.
specifies vertical alignment.
specifies text wrap.
banding color of group 1.
banding color of group 2.
specifies that banding is enabled.
banding group 1.
banding group 2.
specifies whether banding is on rows or columns.
bottom border color.
bottom border style.
horizontal inside border color.
horizontal inside border style.
left border color.
left border style.
right border color.
right border style.
top border color.
top border style.
vertical inside border color.
vertical inside border style.
specifies whether the font is bold.
color of the font.
specifies whether the font is italic.
name of the font.
script of the font.
size of the font.
specifies whether the font is strikedout.
specifies whether the font is underlined.
level of the grid unit when saving
the grid properties. The possible values are:
1 - Grid
2 - Header
3 - Subtotal grid
4 - Subtotal header
number category.
currency position.
currency symbol.
decimal places of the number.
number format.
currency position.
thousand separator.
pattern color.
pattern fill color.
pattern style.
unit of the grid. The possible
values are:
1 - Template Unit
2 - Template Metric
3 - Rows
4 - Cols
max number of columns for the grid.
max number of rows for the grid.
start column of the grid.
start row of the grid.
boolean property to specify, if the event should do a check for user autostyle preference and apply if there's one.
specifies whether the add/remove form operation should be applied to the working set.
Specifies an argument indicating whether it is collated in printer.
Specifies an argument indicating whether it is a portait in printer.
location key for scheduled file and print export
Specifies an argument for max wait in report execution.
String argument specifying the message id of a report instance.
alias for a metric.
destination position of the metric in the metrics collection.
formula for a derived metric.
String argument specifying the id of the metric.
key of a specific metric in the collection.
name of the metric
starting position of the metric in the metrics collection.
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 UNIT_PROPERTY_SEPARATOR
and MULTIPLE_UNITS_SEPARATOR
.
The order of these properties needs to be conformed to the above syntax.
Argument specifying the new column size for a column resize request.
Specifies the node key of the grid-graph object in the doccument
Specifies an argument for the original report message id in document drilling.
Specifies an argument for the original report's prompt answer XML in document drilling.
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.
String argument specifying whether the report should
be displayed in outline mode.
possible values are:
HIDE_OUTLINE_MODE
SHOW_OUTLINE_MODE
key for setting the page-by element.
The format of the key is a list of one or more position + elementID pairs:
positionPAGE_BY_KEY_SEPARATOR
elementID
(PAGE_BY_KEY_SEPARATOR
positionPAGE_BY_KEY_SEPARATOR
elementID)*
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.
Specifies an argument for the new prompt answer for
WebElementsPrompt
in
document drilling.
Specifies an argument for the new prompt answer for
WebObjectsPrompt
in
document drilling.
Specifies an argument for the new prompt answer for
WebConstantPrompt
in
document drilling.
An integer prompt answer mode from EnumWebPromptAnswerMode
Specifies an argument for range end in printing.
Specifies an argument for range start in printing.
Argument indicating whether the report should be re-executed with fresh execution flags.
An integer that represents the view modes to remove from the available view media property
display flag to be used while performing report execution.
Specifies an argument for report name.
argument indicating the columns per page desired for a report page info
Argument indicating the rows per page desired for a report page info
During setting report page info, if this argument is set to true, the resulting window properties are saved on IServer.
argument indicating the type of report page info. Absolute or Relative.
Possible values are listed in EnumReportPageType
Argument indicating the X Position of the desired page on a report
Argument indicating the Y Position of the desired page on a report
rePrompting option for refreshing a report.
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 getKey()
. If the request to resize is for All Columns
then the column identifier should be sent as the string AllColumns (case insensitive).
result flags.
Argument specifying the row height for a row scenario of type DssXmlWidthFitToContent
Argument specifying the row scenario to be set. Possible values are DssXmlWidthFitToContent
and DssXmlWidthFixed
Specifies the page by elements on the report writing document for the
grid graph object that was drilled on. These are separated by METRIC_ELEM_LIST_SEPARATOR
SaveAs report description.
save as flags.
SaveAs report name.
SaveAs parent folder.
Specifies whether to save the message to inbox.
Argument specifying whether to overwrite an existing schedule during schedule. A value of 1 indicates that it should be overwritten.
integer argument indicating whether the message should be reused while scheduling
1 indicates that it should be reused.
Specifies an argument for graph series.
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 REPORT_PROPERTY_LIST_SEPARATOR
boolean argument indicating whether banding should be shown.
a value of HIDE_BANDING
indicates that banding should be hidden.
otherwise it is shown
boolean argument indicating whether subtotals should be shown.
possible values are:
SHOW_SUB_TOTALS
HIDE_SUB_TOTALS
number of sorts that should be applied to the report.
specifies whether the previous sorts should be cleared before adding the current ones.
sort key.
The format of the key is as follows:
SORT_PARAM_TYPE
=type<sep>SORT_PARAM_ID
=id<sep>SORT_PARAM_FORM_ID
=id<sep>SORT_PARAM_FORM_TYPE
=type<sep>SORT_PARAM_ELEM_LIST
<sep>SORT_PARAM_AXIS
where <sep> is SORT_PARAM_SEPARATOR
SORT_PARAM_ELEM_LIST is a list of elements separated by SORT_ELEM_LIST_SEPARATOR
order of the sort -- SORT_ORDER_ASCENDING
/SORT_ORDER_DESCENDING
.
The default is SORT_ORDER_ASCENDING
argument indicating where the subtotals should be placed once the sorting is performed.
state id of a report instance.
String argument specifying the name of the style to apply.
String argument indicating the address ID.
String argument indicating the physical addresses to be used for subscription.
This constant is deprecated.
replaced by REPORT_EVENT_ARGUMENT_SUBSCRIPTION_CONTENT_FORMAT_MODE_ALL_PAGES
Denotes whether the only the current page, or all pages is applied to the subscription.
Denotes whether the only the current page (value of "0"), or all pages is applied to the subscription (value of "1").
Denotes whether multiple pages should be separated (value of "1") on different worksheets - currently only applicable to Excel exports.
Message to be saved along with the email subscription
String argument indicating the deviceID.
String argument indicating the email subject to be used for subscription.
The serialized state of the delivery format
Argument indicating the target object to be used to initialize the report bean using a subscription.
Subscription notification is sent to this existing address.
Subscription notification is sent to this new address. If this is supplied, it
takes precedence over
REPORT_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_ID
.
Specifies an event argument for subscription notification device id.
Specifies an event argument for subscription print all.
String argument indicating sendnow property for subscription.
Indicates whether the format should be zipped
subtotal style.
type of subtotal to be added/removed.
Argument indicating the target object to be used to initialize the report bean using a schedule.
new alias of the template unit.
destination axis.
destination position of the template unit.
dss id of the template unit.
key of the template unit.
name of the object on this template unit
origin axis.
origin position of the template unit.
type of template unit, as defined in EnumDSSXMLTemplateUnitType
.
Specifies the tree type to which the grid-graph object in the doccument belongs to
String argument indicating the trigger to be used.
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
integer argument of EnumWebReportViewMode
specifying the report view mode.
Visualization mode.
object ID to remove from the working set.
Argument indicating the subtype of the object.
object type to remove from the working set.
Specifies the DSSID of the xda report
Event for canceling a reprompt request.
Event for canceling the request.
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.
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.
Event for change report view mode to grid, graph or both.
Event for clearing the page by axis.
Clears all the WebSorts objects contained in the report.
This event would convert a report to datamart. The possible parameters that can be sent in are:
Event for disabling either a specific type of subtotal. If the type is not specified, all the subtotals are disabled.
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.
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.
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.
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
setAsync(boolean)
Sets the flags for execution based on templateID and filterID.
Event for performing a drill on the report graph. The coordinates on which to drill should be specified.
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.
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.
Event for performing a drill with the template fixed. This just filters on a given list of elements.
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.
Event for applying hierarchical metric sort in outline mode. If the subtotal
parameter is not specified, the default is DssXmlMetricSubtotalSum
.
Event for doing an incremental fetch on the report using its
ReportPageInfo
.
This constant is deprecated.
Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions.
Please use REPORT_EVENT_INITIALIZE_FROM_SUBSCRIPTION
instead.
Event for initializing the report bean using a schedule.
Event for initializing the report bean using a subscription.
Event for moving a metric within the metric collection. The origin and the destination position should be specified.
Event for setting multiple sort objects. Similar to 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.
Event for navigate pages for the report page-by operation.
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.
Event for redo current report to next state.
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.
Specifies an event to remove all working set metrics.
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.
Removes a metric based on the specified key or position. If the key or position are not specified, then all the metrics are removed.
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 REPORT_EVENT_ARGUMENT_MULTIPLE_UNITS
for more details on the format
of the arguments
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.
Event for removing a unit from the working set.
Event for reseting the changes made on the report.
resets the stateID
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 REPORT_EVENT_ARGUMENT_COLUMN_IDENTIFIER
argument should be set to "allcolumns".
Event for resizing the column widths. This event supports sending multiple column resize requests.
Event for saving a report back into metadata. This requires a name and a parrent folderID. The arguments that are supported are
Specifies an event to save associated schedule.
Specifies an event to save associated users
Specifies an event to save subscription to a file.
Event for saving the graph axis properties.
Event for saving graph format properties
Event for saving the graph properties.
This constant is deprecated.
Please use REPORT_EVENT_SAVE_GRAPH_FORMAT_PROPERTIES
instead.
Event for saving the graph text properties.
Event for saving the grid alignment properties.
Event for saving the grid banding properties.
Event for saving the grid border properties.
Event for saving the grid font properties.
Event for saving the grid number properties. The possible arguments are:
Event for saving the grid pattern properties.
Specifies an event to print subscription.
This constant is deprecated.
Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions.
Please use events defined on the SubscriptionBean
instead
Event for saving a web schedule. The caller has to specify a valid triggerID
REPORT_EVENT_ARGUMENT_TRIGGER_ID
REPORT_EVENT_ARGUMENT_SCHEDULE_REUSE_MESSAGE
REPORT_EVENT_ARGUMENT_SCHEDULE_OVERWRITE
REPORT_EVENT_ARGUMENT_SCHEDULE_OVERWRITE
argument is set to 0
and the REPORT_EVENT_ARGUMENT_SCHEDULE_REUSE_MESSAGE
argument is set to 0Event 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
REPORT_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_ID
REPORT_EVENT_ARGUMENT_SUBSCRIPTION_ADDRESS_VALUES
REPORT_EVENT_ARGUMENT_TRIGGER_ID
REPORT_EVENT_ARGUMENT_SUBSCRIPTION_EMAIL_SUBJECT
REPORT_EVENT_ARGUMENT_SUBSCRIPTION_SEND_NOW
REPORT_EVENT_ARGUMENT_SUBSCRIPTION_CUSTOM_MESSAGE
REPORT_EVENT_ARGUMENT_SUBSCRIPTION_FORMAT_STATE
REPORT_EVENT_ARGUMENT_SUBSCRIPTION_ZIP_CONTENTS
Event for saving the report to Inbox.
Event for setting the column scenario. If the scenario is set to DssXmlWidthFixed
,
default grid and header widths should be specified too.
Specifies an event to set the cube mapping.
Event for setting the current element in the page by axis.
Event for setting values for specific properties
The argument needed for this event is REPORT_EVENT_ARGUMENT_SET_PROPERTY_VALUE
Sets the report page info on the Report Bean. It also saves the resulting window properties to IServer, if specified.
Specifies an event to set the report result settings.
Event for setting the limits of the result window. The grid/graph start/max rows/columns can be set
Event for setting the row scenario. If the row scenario is set to DssXmlWidthFixed
,
row height should be specified too.
Event for enabling/disabling the thresholds correponding to metrics.
Event for changing the view media settings
Event for showing or hiding the banding.
Sets the flag that specifies whether the report should be displayed as outline mode or not.
Sets the flag that shows subtotals on the template.
Event for setting the sort object.Defines the sorts to be added.
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 REPORT_EVENT_ARGUMENT_METRIC_KEY
is supplied, the event changes the alias of the metric
Otherwise, it looks for the REPORT_EVENT_ARGUMENT_TEMPLATE_UNIT_KEY
Event for undo current report to previous state.
This event would convert a report to datamart. The possible parameters that can be sent in are:
Specifies a separator for report property list.
Constant specifying that banding should be displayed.
Constant specifying that outline mode should be displayed.
Constant specifying that sutotals should be shown.
Specifies a separator for element list in sorting.
Constant specifying that the existing sorts on the template should first be cleared.
Constant specifying that the sort order should be ascending.
Constant specifying that the sort order should be descending.
Specifies a sorting parameter for sort axis.
Specifies a sorting parameter for element list.
Specifies a sorting parameter for sort form id.
Specifies a sorting parameter for sort form type.
Specifies a sorting parameter for sort id.
Specifies a separator for sort.
Specifies a sorting parameter for sort type.
Separator between each property that is used to specify the report object. For most of the report objects
this is the type and DSS ID of the object. For attribute forms, this is the type, attribute ID and form ID.
Used in the REPORT_EVENT_ARGUMENT_MULTIPLE_UNITS
argument