EnumRWBeanEvents

Separates one property group declaration from another.

Event to add/move attribute form. Arguments: REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT REPORT_WRITER_EVENT_ARGUMENT_OBJECT_ID REPORT_WRITER_EVENT_ARGUMENT_FORM_ID REPORT_WRITER_EVENT_ARGUMENT_INDEX

An integer that represents the view modes to add to the available view media property

Event that adds control to document

Event that adds control to document template

Event that adds data set to document and then copies the data set template to document template

Associates another data set with the RW document. This event will also trigger an applyNow, i.e. deltas will be submitted to the IServer.

Event to add a data set template.

Event to get deltaXML from client side Arguments: REPORT_WRITER_EVENT_ARGUMENT_DELTAXML REPORT_WRITER_EVENT_ARGUMENT_APPLY_NOW

Adds a derived metric expression. It is defined within a document, and is associated with a residing data set. The derived metric may be reused with embedded grids or text fields.

Event to add a new group.

Event to add a new HTML container object.

Adds a new image source by URL.

Event for adding a line.

Event that adds panel to the panel stack

Event that adds panel stack

Event to add a new shape object.

Event to add shortcut metric REPORT_WRITER_EVENT_ARGUMENT_DATA_SET_OBJECT_ID (required) REPORT_WRITER_EVENT_ARGUMENT_DATA_SET_OBJECT_TYPE (required) REPORT_WRITER_EVENT_ARGUMENT_OBJECT_KEY REPORT_WRITER_EVENT_ARGUMENT_TREE_TYPE REPORT_WRITER_EVENT_ARGUMENT_FUNCTION_TYPE (required) REPORT_WRITER_EVENT_ARGUMENT_FUNCTION_TYPE2 REPORT_WRITER_EVENT_ARGUMENT_UNITS_COLLECTION

Event to add a subsection.

Adds a template object to the section specified. If the dataset is unspecified, it will be associated with the primary dataset.

Event to add a new text object.

Event to update an RW Instance with transaction changes Arguments: REPORT_WRITER_EVENT_ARGUMENT_TRANSACTION_STRING (required=1) REPORT_WRITER_EVENT_ARGUMENT_APPLY_NOW (required=0)

Event to apply attribute re-map REPORT_WRITER_EVENT_ARGUMENT_DATA_SET_OBJECT_ID (required) REPORT_WRITER_EVENT_ARGUMENT_TARGET_DATASET_ID REPORT_WRITER_EVENT_ARGUMENT_SOURCE_ATT_ID REPORT_WRITER_EVENT_ARGUMENT_TARGET_ATT_ID (required) REPORT_WRITER_EVENT_ARGUMENT_SOURCE_ATT_NAME REPORT_WRITER_EVENT_ARGUMENT_TARGET_ATT_NAME

Event that sets current elements for control on graph

Triggers an apply changes call. Useful after sending back a large of events, which utilize the REPORT_WRITER_EVENT_ARGUMENT_APPLY_NOW=0 attribute.

Event to apply an existing segment to a document

Event to apply document theme REPORT_WRITER_EVENT_ARGUMENT_THEME_ID REPORT_WRITER_EVENT_ARGUMENT_IS_LINK

Integer from EnumDSSXMLRWControlActionType

Sort keys separated by unit_separator

Derived metric alias.

Flags indicating allow or deny user to subscribe, 1 means allow, 0 means deny

When set to "true" or "1", this argument will send all accumulated manipulations to the IServer. Set to "false" or "0" to suppress applying changes. If this argument is optional, it will be set to true.

Argument specifying associated nodes to be set

Template access bit map

Base key of subsection.

Key of the object coming before the target.

String message will be displayed after user click submit and the submit is successful

An integer mode from EnumWebControlDataFilterModes

The display text for the action selector

Argument specifying list of forms separated by ITEM_SEPARATOR

Argument specifying form delimiter string

Argument specifying display type from EnumDSSXMLControlAttributeFormDisplayOption

Argument used in REPORT_WRITER_EVENT_REORDER_CONTROL_GROUP_BY event. The argument is string that represents the final control group by order. The format of the string is a list of group by keys delimited by CONTROL_GROUP_BY_REORDER_SEPARATOR. The event will determine the 'moves' required to achieve this final order. If a wrong/invalid key is sent in the argument, it will be ignored For example K21!K24!K39 is a valid argument value.

Argument used in the REPORT_WRITER_EVENT_REORDER_CONTROL_GROUP_BY event. The argument is a collection of control group by order instructions. Each instruction is a group key and action pair - delimited by a CONTROL_GROUP_BY_REORDER_SEPARATOR. The instructions are delimited by CONTROL_GROUP_BY_SEPARATOR. The action can either ACTION_MOVE_DOWN or ACTION_MOVE_UP
For example: "K21!1,K45!2" will move up the control group by with key K21 and move down the control group by with key K45

Control key

A string containing a list of control keys separated by ITEM_SEPARATOR symbol

Specifies control multi-select option

Specifies control orientation (see EnumRWOrientation)

Select top most element in action control in grid

Control Show All option

Argument specifying sort parameters delimited by ITEM_SEPARATOR

Control source object ID

Control source object type

Control style (see EnumRWControlStyle)

A string containing a list of control texts separated by ITEM_SEPARATOR symbol

Control type (see EnumDSSXMLRWControlType)

Convert from VI flag

Copies for print schedule.

An integer describing count

Flags governing report to document creation. See EnumDSSXMLRWEaseCreationFlags.

Optional template ID for report to document creation

Alias to used for control Select All option.

Control mouse option action (for Flash);

Control dataset target ID

Data serve mode. 1 -> In-Memory 2 -> Direct Access

By default this optional value is set to 0 (false), where a data set will NOT be removed if there are objects that refer to it. If set to 1, the data set will be removed along with any objects that refer to it.

Data set ID.

Underlying object ID of the data set.

Underlying object type of the data set (see EnumDSSXMLObjectTypes).

Indicates a data type from EnumDSSXMLDataType

An string present the manipulator deltaXml

Destination position of the derived metric in the metrics collection.

A list of keys of the document units that need to be redisplayed.

Display flags (see EnumDSSXMLDisplayMode).

Element action (see EnumDSSXMLCurrentElementAction).

Element ID.

List of selected elements

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

Execution mode (see EnumRWExecutionModes).

Execution flags

Specifies the export mode. Should be a value from EnumRWExportModes

Indicates a set of constants to be used in an expression. Separated by ITEM_SEPARATOR

Indicates an int from EnumDSSXMLFunction or EnumWebMRPFunction

Indicates an int from EnumWebFunctionType

File name for file export.

Footer section key.

Footer subsection key.

Formatting property height.

Formatting property horizontal alignment.

Formatting property left position.

Argument indicating line orientation.

Formatting property top position.

Formatting property width.

Format type (see EnumRWFormatTypes)

Derived metric formula.

Indicates the main function type in REPORT_WRITER_EVENT_ADD_SHORTCUT_METRIC. This argument is required.

Indicates the optional second function type in REPORT_WRITER_EVENT_ADD_SHORTCUT_METRIC

Flags controlling group by behavior

Sort key. The format of the key is as follows:

Group key.

Collection of group elements. Each group element is a group key and element ID pair - the group key and element ID are delimited by the UNIT_SEPARATOR, and groups elements are delimited by the ITEM_SEPARATOR. E.g. [UNIT_SEPARATOR] [ITEM_SEPARATOR][UNIT_SEPARATOR].

Group object ID.

Object subtype (see EnumDSSXMLObjectSubTypes).

Group object type (see EnumDSSXMLObjectTypes).

Header section key.

Header subsection key.

Governs the HTML container resolution. A HTML type of 0 will resolve REPORT_WRITER_EVENT_ARGUMENT_HTML_URL, while a type of 1 will resolve REPORT_WRITER_EVENT_ARGUMENT_HTML_TEXT.

list of attributes that should be included as part of the answers This is of the format attrID1,attrID2,attrID3,attrID3

Don't get the stauts of the message before performing the action

Image url.

Image URL Type

Indicates whether to include the MD properties on the visualization's data XML

Whether printing is to be collated.

Indicates that layout being removed is a current layout

Whether a dataset has been added.

Whether this is the default.

Indicates a boolean value specifying whether the control selection should be inclusive

Apply theme in link style or copy style

Whether print page is in portrait or landscape mode.

Derived Metric event argument to indicate whether argument value is a formula string or token stream xml.

List of keys, delimited by ITEM_SEPARATOR.

Label value.

Indicates the layout ID

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

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

Location key for file and print export.

Argument specifying the manipulation category for the associated nodes

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

Media type

Message ID.

Specifies direction for moving a panel within panel stack

Flags indicating non-schedulable

Object ID.

Object key.

Object name.

Object type (see EnumDSSXMLObjectTypes).

An integer that represents the submission order list

TQMS 878878, The source document ID argument for document linking.

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

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

Page-by style.

Panel key

Indicates a set of partial display keys separated by ITEM_SEPARATOR

Specifies element prompts' answers in a URL friendly format.

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.

Polling frequency.

Populate option for populating document template with data set template

An integer prompt answer mode from EnumWebPromptAnswerMode

Stop printing at this page. Also see REPORT_WRITER_EVENT_ARGUMENT_RANGE_START.

Start printing from this page. Also see REPORT_WRITER_EVENT_ARGUMENT_RANGE_END.

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

Indicating whether to remove message from inbox when cancel request

State ID of report to be converted into a RW document.

Reprompting option for refreshing.

Save-as description.

Save-as flags (see EnumDSSXMLReportSaveAsFlags).

The new save-as name.

Object id of the parent folder.

Schedule execution flags.

assoiciated schedule list

Specifies whether any existing schedule for the same RW Object (and trigger) should be overwritten.

Specifies whether to reuse the message ID while scheduling

Section key.

Selected visualization

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

Data argument.

 data := property [ITEM_SEPARATOR property]
 property := propertySetName UNIT_SEPARATOR name UNIT_SEPARATOR value
 propertySetName name value := STRING | EMPTY
 

Compact representation supported - see REPORT_WRITER_EVENT_ARGUMENT_SET_VIEW_PROPS_DATA for a similar example.

Data argument for edit properties. EBNF definition is as follows:

 data := property [ITEM_SEPARATOR property]
 property := key UNIT_SEPARATOR propertySetName UNIT_SEPARATOR name UNIT_SEPARATOR value
 key propertySetName name value := STRING | EMPTY
 

If the key, propertySetName, or name is omitted, the previous declaration will be used - allowing for a relatively compact representation. For example, consider the data string;

 A112[UNIT_SEPARATOR]FormattingPosition[UNIT_SEPARATOR]Top[UNIT_SEPARATOR]18[ITEM_SEPARATOR][UNIT_SEPARATOR][UNIT_SEPARATOR]Left[UNIT_SEPARATOR]15
 

maps to the following two property settings:

• key = A112
• propertySetName = FormattingPosition
• name = Top
• value = 18

and

• key = A112
• propertySetName = FormattingPosition
• name = Left
• value = 15

Data argument. EBNF definition is as follows:

 data := property [ITEM_SEPARATOR property]
 property := [templateKey] UNIT_SEPARATOR propertySetName UNIT_SEPARATOR name UNIT_SEPARATOR value
 templateKey propertySetName name value := STRING | EMPTY
 

If the templateKey, propertySetName, or name is omitted, the previous declaration will be used - allowing for a relatively compact representation. For example, consider the data string - the second declaration omits the templateKey:

 K21[UNIT_SEPARATOR]ps1[UNIT_SEPARATOR]xxx[UNIT_SEPARATOR]15[ITEM_SEPARATOR][UNIT_SEPARATOR][UNIT_SEPARATOR]yyy[UNIT_SEPARATOR]16
 

maps to the following two property settings:

• templateKey = K21
• propertySetName = ps1
• name = xxx
• value = 15

and

• templateKey = K21
• propertySetName = ps1
• name = yyy
• value = 16

Event argument shape type (see EnumDSSXMLShapeType).

Graph slice ID

Event argument sorts count.

Set using SORT_EVENT_SET_CLEAR.

This is either SORT_ORDER_ASCENDING or SORT_ORDER_DESCENDING

Template to copy from.

Indicates the state ID argument that is added handled by the EnumRWBeanEvents.REPORT_WRITER_EVENT_REFRESH event.

An integer describing status

Address ID for email subscription.

Address values for email subscription.

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.

Custom message for email subscription.

Device ID for email subscription.

Subject for email subscription.

Event argument subscription format state.

Subscription ID for initializing a RW Bean with 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_WRITER_EVENT_ARGUMENT_SUBSCRIPTION_NOTIFICATION_ADDRESS_ID.

Subscription notification device ID.

Whether to print all pages.

Send now flag for email subscription.

Argument indicating whether to zip contents of subscription.

Subsection key.

Integer from EnumDSSXMLRWControlSubsequentAction

The dssID of the document or report to be executed after submit

The object name of the document or report to be executed after submit

Integer from EnumDSSXMLObjectTypes

Target object ID for initializing a RW Bean with Schedule

Control target key

A string containing a list of control target keys separated by ITEM_SEPARATOR symbol

Target object key.

Control dataset type

Indicates that imported document is a template

Event argument template display mode (see EnumDSSXMLDisplayMode).

Template position

The theme id to be applied

XML String containing the transactcion changes to be applied to an RW instance

The trigger ID for scheduling/subscription.

Indicates the units collection in REPORT_WRITER_EVENT_ADD_SHORTCUT_METRIC, with format of DSSIDUNIT_PROPERTY_SEPARATOREnumDSSXMLObjectTypesMULTIPLE_UNITS_SEPARATOR;

Specifies an argument used to identify a RW unit.

The unit's visibility (0 = false)

List of derived attributes to delete.

Each metric is a pair consisting of a data set ID and metric ID (delimited by UNIT_SEPARATOR). This argument is a list of metric pairs (delimited by ITEM_SEPARATOR).

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

Whether to use default prompt answers.

Indicates whether partial display can be used for event

Whether to use the view template data set. When creating a data set template, this argument if true will add only the data set objects as specified in the view template, otherwise all objects (e.g. metrics, attributes) are added from the data set. True by default.

Indicates the visualization's image

Visualization mode.

Indicates the visualization properties

Location is either "after" or "before".

Cursor X coordinate

Cursor Y coordinate

The z-index.

Event for canceling a reprompt request.

Event for canceling the request.

Event that changes the dataset used by a GridGraph unit

Event to convert a given GridGraph object from being an embedded object (that can be modified) to a link to an existing dataset (and thus cannot be modified)

Event to change the unset properties of a selector control Arguments: REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT (required=2) REPORT_WRITER_EVENT_ARGUMENT_CONTROL_KEY (required=2) REPORT_WRITER_EVENT_ARGUMENT_STATUS (required) REPORT_WRITER_EVENT_ARGUMENT_COUNT REPORT_WRITER_EVENT_ARGUMENT_APPLY_NOW

This event sets up the export settings for export to PDF/Excel. Note that the event does just sets up the web objects with the settings specified. The settings are not persisted on IServer in any way.

Copies an object unit along with its properties. May optionally specify a new position and section.

Event to copy the current selection to the clipboard.

Event to cut (as part of a move operation) the current selection to the clipboard.

Event to configure sorting in the details section.

Event to execute a grid drill.

Event to edit a derive metric.

Edits an image source URL.

Event for editing a line.

Event to edit a shape object.

Used for editing the text value.

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

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

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

fill specified fields with supplied data

Event to discard any errors on the bean, and removes all embedded beans.

Event to set the format of the derived metric.

Event for initializing the RW Bean with a schedule.

Event for initializing the RW Bean with a subscription.

Event to link attributes.

Event to move a group.

Used to move objects (e.g. labels, data fields) to different sections. May also be used to reposition the object, but it would be better to use the REPORT_WRITER_EVENT_ARGUMENT_EDIT_PROPERTIES_DATA event instead.

Event that changes panel order in the panel stack

Copies properties from the source to the target unit object(s). Target keys are specified in a comma delimited list.

Event to paste contents from the clipboard.

Event to perform an action on an Action Selector Arguments: REPORT_WRITER_EVENT_ARGUMENT_CONTROL_KEY (required=2) REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT (required=2) REPORT_WRITER_EVENT_ARGUMENT_ACTION_TYPE (required=1) REPORT_WRITER_EVENT_ARGUMENT_APPLY_NOW (required=0)

Event to pivot a template unit in a grid within the RWD. Only used to pivot units already in template Arguments: REPORT_WRITER_EVENT_ARGUMENT_UNIT_KEY_CONTEXT REPORT_WRITER_EVENT_ARGUMENT_OBJECT_TYPE can be a list of object types separated by ITEM_SEPARATOR REPORT_WRITER_EVENT_ARGUMENT_OBJECT_ID can be a list of object IDs separated by ITEM_SEPARATOR. Leave blank for Metrics TemplateUnit REPORT_WRITER_EVENT_ARGUMENT_AXIS REPORT_WRITER_EVENT_ARGUMENT_TEMPLATE_POSITION

Event that populates document template from data set template

Event for refreshing the RW document.

An integer that represents the view modes to remove from the available view media property

Event that remove control to document template

Event to remove a data set from the document.

Event to delete derived attributes.

Event to remove 1 or more derived metrics.

Event to remove a group.

Used to remove objects (e.g. labels, data fields).

Event that removes panel from the panel stack

Event to remove a subsection.

Event to remove targeted place holders. Arguments: REPORT_WRITER_EVENT_ARGUMENT_PLACEHOLDER_KEYS_STR

Event to remove document theme REPORT_WRITER_EVENT_ARGUMENT_THEME_ID REPORT_WRITER_EVENT_ARGUMENT_IS_LINK

Event to re-order a list of control group by's

Event to reset document selections

Reverts all formatting properties of specified unit to their default values.

Event to save the document.

Event for saving subscription.

Save a scheduled file export.

Save a scheduled print export.

Event for saving schedule.

Event for adding RW message to Inbox.

Event to set associated nodes to a RWNode for specified manipulation category REPORT_WRITER_EVENT_ARGUMENT_OBJECT_KEY (required) REPORT_WRITER_EVENT_ARGUMENT_ASSOCIATED_NODES REPORT_WRITER_EVENT_ARGUMENT_MANIPULATION_CATEGORY (required)