Page Configuration File XML Structure

Indicates the name of the element described in the next three columns. If this is a parent element, the names of all possible child elements are listed below the parent element.

Specifies the number of nodes that are required or allowed for the corresponding element in the Parent Element column. For example, if the value is "1", there must be only one node— no more, no less. If the value is "0 or more", the node is not required ("0"), but there is no restriction on the number of nodes that can be added ("or more"). If the value is "1 or more", the node is required ("1"), but there is no restriction on the number of nodes that can be added ("or more").

Lists the separate attributes that can be used with the corresponding element in the Parent Element column. Included in parentheses beneath each attribute name are the attribute type and an indication of whether the attribute is required or implied. For example, the version attribute for the <framework> element has an attribute type of "nmtoken" (name token) and is implied. The named-page attribute for the <mapping> element has an attribute type of "cdata" (character data) and is required.

Describes either a parent element in the Parent Element column or an attribute in the Parent Element Attributescolumn.

The <framework> element is the root element of the page configuration file.

The version attribute indicates the release number of the page configuration file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

The name attribute identifies the page configuration file. This attribute is not used by the application, but it helps you to identify the page configuration file.

The desc attribute describes the page configuration file. This attribute is not used by the application, but it provides a data field where you can describe the page configuration file.

Description

The <folderpage-mapping> element lists a series of folder mapping definitions. Each of these <mapping> elements defines a default page that the application uses to display the contents of the metadata project folder specified by the named-page attribute of the <mapping> element.

If the folder mappings are defined in a separate file, the config-src attribute tells the page configuration file the location of the folder mapping configuration file.

If the folder mappings are defined in a separate file, the version attribute indicates the release number of the folder mapping configuration file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

The <mapping> element defines a single folder mapping. This folder mapping indicates the default page that the application uses to display the contents of the metadata project folder specified by the named-page attribute.

The target-page attribute indicates the name of the default page to open (for example, "shared" or "my") when the application browses to the folder specified by the named-page attribute.

The named-page attribute indicates the system folder to associate with the page identified by the target-page attribute. The value is the fully-qualified name of the EnumDSSXMLFolderNames interface (for example, "com.microstrategy.webapi.EnumDSSXMLFolderNames. DssXmlFolderNamePublicReports").

Description

The <paper-sizes> element lists a series of paper size definitions. These <paper-size> elements are used to define the valid sizes of pages that the application presents to the user when the print functionality is used.

If the valid paper sizes are defined in a separate file, the config-src attribute tells the page configuration file the location of the paper size configuration file.

If the valid paper sizes are defined in a separate file, the version attribute indicates the release number of the paper size configuration file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

The <paper-size> element defines a single valid paper size. The application presents this paper size to the user when the print functionality is used.

The desc attribute provides the descriptor that the application should use to display the paper size if the desc-id attribute is missing.

The desc-id attribute provides the Resource Bundle item id that the application should use to display the paper size descriptor in the language of the user's locale.

The desktop-key attribute is a unique identifier used by MicroStrategy Developer to identify the paper size.

The key  attribute is a unique identifier used by MicroStrategy Web to identify the paper size.

Description

The <errors> element lists the errors or special conditions that can occur in the application. The application uses this list to change the title and message of the error, to indicate whether the error is expected by the iframe in the event of an iframe request, or to find the page to which the user is redirected when an error occurs.

If the errors are defined in a separate file, the config-src attribute tells the page configuration file the location of the errors configuration file.

If the errors are defined in a separate file, the version attribute indicates the release number of the errors configuration file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

The <error> element is used by the application to change the title and message of the error, to indicate whether the error is expected by the iframe in the event of an iframe request, or to find the page to which the user is redirected when the error occurs.

The code attribute identifies the error. This can be an error code from Intelligence Server or a value from the EnumWebAppErrorCodes interface.

The displayError attribute indicates whether the application should render the title, message, and contact information (if showContactInfo is set to 'true') when the error occurs.

The showContactInfo attribute indicates whether the application should render the contact information (if available) from the Project Defaults page when error information is displayed to the user.

The target attribute indicates the page to which the user should be redirected when the error occurs.

The useOriginalMessage attribute indicates whether the application should display the original error message returned by the error object. (This is the error message generated on the back-end.)

The <title> element defines the title to be displayed in the error alert box.

The desc attribute provides the descriptor that the application should use to display the error title if the desc-id attribute is missing.

The desc-id attribute provides the Resource Bundle item id that the application should use to display the error title in the language of the user's locale.

The <message> element defines the message to be displayed in the error alert box.

The XMLmerge_id  attribute is a unique identifier that is used by the upgrade utility rather than the application.

The desc attribute provides the descriptor that the application should use to display the error message if the desc-id attribute is missing.

The desc-id attribute provides the Resource Bundle item id that the application should use to display the error message in the language of the user's locale.

Description

The <folder links> element lists a series of folder link definitions. Each <folder link> element  represents a shortcut to a system folder. These shortcuts are rendered in several folder browsers within the application, such as the Report All Object Browser and the browsers associated with the Save As Dialog and the Object Manipulation Dialog.

If the folder links are defined in a separate file, the config-src attribute tells the page configuration file the location of the folder links configuration file.

If the folder links are defined in a separate file, the version attribute indicates the release number of the folder links configuration file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

The <context> element defines a group of folder links, or shortcuts. A context is generally associated with a single editor or folder browser in the application (specified through a setting in the editor or browser). The context can include different sets of folder links for different projects.

The id attribute is a unique identifier for the context.

The desc attribute provides a description of the context. This attribute is not used by the application, but it can be used to make the XML file more readable.

The <project> element groups a set of shortcuts to system folders on a project basis. It is found inside a context and can be used to determine which folder links, or shortcuts, should appear on browsers in which MicroStrategy projects. Shortcuts under the default  project appear in all projects.(The default project is the <project> element with the default attribute set to 'true'.)

The id attribute indicates the id of the project (from the metadata) that is associated with the group of folder links, or shortcuts.

The name attribute indicates the name of the project (from the metadata) that is associated with the group of folder links, or shortcuts.

The default attribute marks the project as the default project. When the value of this attribute is 'true', the shortcuts defined inside this <project> element appear in all projects.

The <folder-link> element defines a shortcut to a folder (in the metadata) that is used by a folder browser or editor associated with the context.

The id attribute provides the GUID for the folder (from the metadata) to which a folder browser or editor should be pointed when the folder link, or shortcut, is selected. The value of this attribute can change between product versions.

The sys-folder-id attribute provides the integer id for the named folder (from the metadata) to which a folder browser or editor should be pointed when the system folder shortcut is selected. The valid values of this attribute are defined in the EnumDSSXMLFolderNames interface. (For example, the name 'DssXmlFolderNameAutoStyles' specifies the 'AutoStyles' folder in the 'Public Objects' folder and has an integer value of '57'.) The value of this attribute does not change between product versions.

The desc attribute provides a descriptor that the application should use to display the folder link, or shortcut, if the desc-id attribute is missing.

The desc-id attribute provides the Resource Bundle item id that the application should use to display the folder link, or shortcut, in the language of the user's locale.

The feature-id attribute represents a feature that is evaluated to determine whether the folder link, or shortcut, should be displayed.

Description

The <export-formats> element groups a list of export format objects. These <export-format> elements are used to define the properties of the different export formats that the application supports.

If the export formats are defined in a separate file, the config-src attribute tells the page configuration file the location of the export format configuration file.

If the export formats are defined in a separate file, the version attribute indicates the release number of the export format configuration file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

The <export-format> element defines the properties of a single export format supported by the application.

The bean-type attribute indicates the bean to which the export format belongs. (If the value of this attribute is set to 'ReportBean', you must set a value for the style attribute.)

The name attribute provides a unique identifier for the export format.

The desc attribute provides a descriptor that the application should use to display the export format if the desc-id attribute is missing.

The desc-id attribute provides the Resource Bundle item id that the application should use to display the export format in the language of the user's locale.

The file-extension attribute indicates the extension that the application gives to the file that is created when exporting using the export format.

The mime-type attribute indicates the mime-type that the export format uses.

The style attribute determines the name of the style (from the Style Catalog) that is used to transform the bean when exporting using the export format. (Since this attribute applies only to export formats that are used for reports, it is not considered a 'required' attribute. However, it is required if the value of the bean-type attribute is set to 'ReportBean'.)

The view-mode attribute indicates the view mode that the export format uses. The values of the attribute are expressed using the fully-qualified name of the constants defined in the EnumWebReportViewMode interface (for example, ReportViewModeGrid).

The export-format-type attribute indicates the associated export format from the EnumExportFormat interface. The value is expressed using the fully-qualified name of the values defined in this interface (for example, ExportFormatExcelWithPlaintext).

The page-name attribute indicates the page (as defined in this file) that the application uses when exporting using the specified export format (for example, exportBinary).

Description

The <visualizations> node lists a series of visualization types. Each child <visualization-list> node represents a collection of visualizations of the same type, such as "flash" for Adobe Flash files, which is defined by the value of the name attribute.

If the visualizations are defined in a separate file, the config-src attribute tells the page configuration file the location of the visualizations configuration file.

If the visualizations are defined in a separate file, the version attribute indicates the release number of the visualizations configuration file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

The <visualization-list> node represents a collection of visualizations of the same type, such as "flash" for Adobe Flash files, which is defined by the value of the name attribute.

The name attribute defines the type of visualizations that are included in this list. It is used in the CSS file to determine the icon that is displayed for folder browsing and on the History List. For example, "flash" is used to specify Adobe Flash files.

There is a one-to-one relationship between the name attribute and the view-mode attribute.

The view-mode attribute specifies the mode in which a report or document to which this visualization is applied should be displayed. It is saved withe the report or document when it is saved. The only internally-supported value in the current release is "50", which indicates a flash visualization. Users can use any other value for their own purposes.

There is a one-to-one relationship between the name attribute and the view-mode attribute.

Each <visualization> node represents one specific visualization.

The desc-id attribute provides a descriptor ID, which can be used for localization. This is the key of the string from the MessageBundles.properties file with the localized description of the visualization. For example, desc-id="custom.1234".

The desc attribute provides a description for the visualization. It is used only if desc-id is empty.

The style-name attribute is the unique name of the style in the Style Catalog that is used to render this visualization. The associated style in the Style Catalog defines the file name of the Flash file (SWF file) to be used, the height, and the width.
 

Two visualizations cannot have the same style.

The scope attribute is a bit-wise value that indicates the objects for which the visualization is available:

1     Available for reports only   (default)

2     Available for grids within documents only

3     Available for reports and grids in documents

4     Available for entire documents

For example, some styles are applicable to reports, some are applicable to report grids in a document, some are applicable to entire documents, and some are applicable to a combination of these.

The projects attribute specifies the projects in which this visualization is available. If this attribute is not present, the visualization is available in all projects.

Description

The <widgets> element groups a list of widgets available for display in Flash mode. These <widgets> elements are used to define the properties of the different widgets displayed in MicroStrategy products..

If the widgets are defined in a separate file, the config-src attribute tells the page configuration file the location of the widgets configuration file.

If the widgets are defined in a separate file, the version attribute indicates the release number of the widgets configuration file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

The <widget> element defines the properties of a single widget that can be displayed in Flash mode.

The id attribute is the unique id for the widget.

The scope attribute represents the field unit type value for the underlying document object. For a list of possible values, refer to com.microstrategy.web.objects.rw.EnumRWUnitTypes.

The fqcn attribute is the fully qualified class name for the widget. It is important to specify the class name correctly since it gets persisted in the metadata, the very first time the widget is used. On subsequent usage, this class name is retrieved from the metadata; not from widgets.xml.

The rslPath attribute provides the relative path to the custom visualization file for the widget from the MicroStrategy Web installation folder.

The title attribute indicates the name displayed in the drop down (if no descriptor is specified in titleId).

The titleId attribute provides a descriptor ID, which can be used for localization. This is the key of the string from the MessageBundles.properties file with the localized description of the visualization. For example, desc-id="scenario1.1".

The titleDescId attribute is reserved for future use. Use default value: "-1".

The tbImage attribute is reserved for future use. Use default value: "" (blank).

The tbClass attribute indicates the CSS class name that will be specified in a CSS file for displaying an icon for the widget.

The previewImage attribute provides the relative path to the icon that will be displayed at the bottom right of the template container in Design mode. The value of  title or titleId is displayed when the cursor hovers over this icon.

Description

The <transitions> element groups a list of transition animations that can be applied to grids or graphs when displayed in Flash mode.

If the transitions are defined in a separate file, the config-src attribute tells the page configuration file the location of the transitions configuration file.

If the transitions  are defined in a separate file, the version attribute indicates the release number of the transitions configuration file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

The <transition> element defines the properties of a single transition animation.

The id attribute is the unique id for the transition.

The title attribute indicates the name displayed in the drop down (if no descriptor is specified in titleId).

The titleId attribute provides a descriptor ID, which can be used for localization. This is the key of the string from the MessageBundles.properties file with the localized description of the visualization. For example, desc-id="scenario1.1".

The defaultSpeed attribute sets the speed for the transition animation.

The scope attribute represents the field unit type value for the underlying document object. For a list of possible values, refer to com.microstrategy.web.objects.rw.EnumRWUnitTypes.

Description

The <menus> element groups a list of menu objects. These <menu> elements define the dynamic menus used by the application.

If the menus are defined in a separate file, the config-src attribute tells the page configuration file the location of the menus configuration file.

If the menus are defined in a separate file, the version attribute indicates the release number of the menus configuration file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

The <shortcut-list-set> element groups a list of shortcut list objects, which each define a group of shortcut objects. These shortcut objects can be used to define menu items, system picker items, links and context menu items.

If the shortcut list set is defined in a separate file, the config-src attribute tells the page configuration file the location of the shortcut list set definition file.

If the shortcut list set is defined in a separate file, the version attribute indicates the release number of the shortcut list set definition file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

The base-bean attribute indicates the bean from the pages bean hierarchy associated with the shortcut lists in the set. If a shortcut list object inside the set does not define a base bean attribute, the value of this base-bean attribute is used in tasks such as resolving features for the shortcut list.

The feature-id attribute represents a feature that is evaluated to determine whether the shortcut list set object should be rendered.

The name attribute provides a unique identifier for the shortcut list set.

If the shortcut list set is associated with a JavaScript bone, the javascript-file attribute defines the JavaScript file that contains the JavaScript class corresponding to the JavaScript bone.

If the shortcut list set is associated with a JavaScript bone, the script-class attribute defines the name of the JavaScript class that corresponds to the JavaScript bone.

The <attributes> element groups a list of attribute objects. These  <attribute> elements define name-value pairs of html attributes that are added to the objects container (that is, added within the <div> tag) when rendered. The <attributes> element is used with system pickers and toolbars, but not menus.

If the attributes are defined in a separate file, the config-src attribute tells the page configuration file the location of the attribute definition file.

If the attributes are defined in a separate file, the version attribute indicates the release number of the attribute definition file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

Description

The <attribute> element defines an html attribute name-value pair that is added to the objects container (that is, added within the <div> tag) when rendered.

The name attribute defines the name of the html attribute to be added to the objects container.

The value attribute defines the value of the html attribute to be added to the objects container.

The <shortcut-list> element represents a menu, system picker, toolbar, or context menu and groups a list of shortcut objects. These shortcut objects can be used to define menu items, system picker items, links and context menu items.

If the shortcut list is defined in a separate file, the config-src attribute tells the page configuration file the location of the shortcut list definition file.

If the shortcut list is defined in a separate file, the version attribute indicates the release number of the shortcut list definition file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

The base-bean attribute indicates the bean from the pages bean hierarchy associated with the shortcut list. If a shortcut object inside the shortcut list does not define a base bean attribute, the value of this base-bean attribute is used in tasks such as resolving features for the shortcut. (If this attribute is not set, the application tries to use the base-bean attribute for the <shortcut-list-set> element.)

The desc attribute provides a descriptor that the application should use to display the shortcut list if the desc-id attribute is missing.

The desc-id attribute provides the Resource Bundle item id that the application should use to display the shortcut list in the language of the user's locale.

The enable-feature-id attribute represents a feature that is evaluated to determine whether the shortcut list object should appear enabled or disabled when it is rendered.

The feature-id attribute represents a feature that is evaluated to determine whether the shortcut list object should be displayed.

The name attribute provides a unique identifier for the shortcut list object.

The columns attribute indicates the number of columns in which the shortcuts is displayed when the shortcut list object represents a system picker.

The css-class attribute defines the css class to associate with the objects container when it is rendered.

The types attribute has only one possible value - 'styles'. When its value is set to 'styles', this attribute indicates that the list to be rendered is associated with a list of metadata styles.

The use-container attribute indicates whether the list is contained in an independent html container.

The use-default attribute indicates whether the shortcut list definition should be inherited from a shortcut list defined in the default page that shares the same name.

Description

The <shortcut> element is used to define menu items, system picker items, links and context menu items.

The append-state attribute indicates whether the shortcut object includes the pages state when it is rendered.

The base-bean attribute indicates the bean from the pages bean hierarchy associated with the shortcut object. This bean is used in tasks such as resolving features. (If this attribute is not set, the application tries to use the base-bean attribute for the <shortcut-list> element.)

The base-bone attribute defines the name of a JavaScript bone with which the shortcut is associated. If present, this bone is used to find the DHTML methods defined in other attributes of the shortcut element.

The desc attribute provides a descriptor that the application should use to display the shortcut if the desc-id attribute is missing.

The desc-id attribute provides the Resource Bundle item id that the application should use to display the shortcut in the language of the user's locale.

The feature-id attribute represents a feature that is evaluated to determine whether the object should be displayed. (This evaluation takes place when the HTML is created, whereas DHTML evaluations take place when the user interacts with the object. If this evaluation returns false, no DHTML evaluations take place, even if they are specified. If this evaluation returns true, the DHTML evaluation  - specified by the dhtml-show attribute - takes place and overrides the result of this evaluation. )

The enable-feature-id attribute represents a feature that is evaluated to determine whether the shortcut should appear enabled or disabled when it is displayed. (This evaluation takes place when the HTML is created and can be over-ridden by the DHTML evaluation - specified by the dhtml-enabled attribute - that takes place when the user interacts with the object.)

The check-feature-id attribute represents a feature that is evaluated to determine whether the shortcut should appear checked or cleared when it is rendered. (This evaluation takes place when the HTML is created and can be over-ridden by the DHTML evaluation - specified by the dhtml-checked attribute - that takes place when the user interacts with the object.)

The feature-target attribute controls whether the target attribute of a shortcut should cause a separate page to display.

The dhtml-show attribute represents a DHTML code segment that is evaluated to determine whether the shortcut should be displayed. (This evaluation takes place when the user interacts with the object and overrides the results of the evaluation that takes place when the HTML is created - specified by the feature-id attribute. However, if the feature-id evaluation returns false, this evaluation never takes place.)

The dhtml-enabled attribute represents a DHTML code segment that is evaluated to determine whether the shortcut should appear enabled or disabled when it is displayed. (This evaluation takes place when the user interacts with the object and overrides the results of the evaluation that takes place when the HTML is created - specified by the enable-feature-id attribute.)

The dhtml-checked attribute represents a DHTML code segment that is evaluated to determine whether the shortcut should appear checked or cleared when it is displayed. (This evaluation takes place when the user interacts with the object and overrides the results of the evaluation that takes place when the HTML is created - specified by the check-feature-id attribute.)

The selected attribute indicates that the shortcut is rendered as the selected item among the other links in the shortcut list.

The extra-url attribute defines a URL segment  that is appended to the links URL.

The href attribute indicates the HTTP resource to which the application is redirected when the shortcut link is clicked.

When the iframe attributes value is set to 'true', the shortcut link uses the application's iframe infrastructure to submit the users request to the Web server.

If the shortcut is represented as an image, the img-height attribute indicates the height of the image.

If the shortcut is represented as an image, the img-src attribute indicates the source path of the image.

If the shortcut is represented as an image, the img-width attribute indicates the width of the image.

The builder-class-name attribute  defines the fully-qualified name of the class to use when building context menu items using the shortcut definition.

The key-shortcut-desc attribute provides a descriptor that the application should use to display the accelerator key (keyboard shortcut) if the key-shortcut-desc-id attribute is missing.

The key-shortcut-desc-id attribute provides the Resource Bundle item id that the application should use to display the accelerator key (keyboard shortcut) in the language of the user's locale.

When rendering multi-column system pickers, the location attribute indicates whether this shortcut is rendered before or after the rest of the shortcuts, outside the columns block. For example, when possible colors are displayed in a grid with rows and columns of color choices, you can use the location attribute to specify that the shortcut should be displayed either above (value = 'prefix') or below (value = 'suffix') this grid.

The name attribute provides a unique identifier for the shortcut.

The onclick attribute represents a DHTML code segment that is evaluated when the shortcut link is clicked.

The shortcut-class-name attribute defines the fully-qualified name of the class to use when building toolbar items using the shortcut definition.

The target attribute indicates the target window to which the request is directed when the shortcut link is clicked.

The bean-style attribute indicates the style from the Style Catalog used to render the shortcuts base bean when the type attribute of the shortcut is set to 'bean'.

The type attribute defines the type of shortcut when used inside a toolbar. There are three possible values. When the value is set to 'colorpicker', the shortcut is a drop-down arrow on the toolbar that opens a grid with color choices in rows and columns. When the value is set to 'button', the shortcut is a button on the toolbar. When the value is set to 'bean', the shortcut on the toolbar represents the base bean in the style defined by the bean-style attribute.

If the use-window-open attribute is set to 'true' and the target attribute is set to a value, the application uses window.open to open the target window specified by the target attribute. (This is used specifically for exporting to provide the new window with a reference to the parent window, so that it can send the updated status back to the parent.)

Description

The <event> element defines either an event to be executed when the user clicks on the parent shortcut link or an update action to be performed - based on user preferences - on the shortcut when the event is handled by the application. (Events that are executed when the user clicks on the parent shortcut link do not have child <argument> elements. Events that cause an update action to be performed on the shortcut must have child <argument> elements.)

The action attribute defines whether the shortcut is checked, cleared, refreshed entirely, enabled or disabled when the event is handled by the application.

The base-bean attribute indicates the bean from the pages bean hierarchy associated with the event. This bean is used in tasks such as resolving features. (If this attribute is not set, the application tries to use the base-bean attribute for the <shortcut> element.)

The event-id attribute indicates the application event id associated with the element.

The feature-id attribute represents a feature that is evaluated to determine whether the event is associated with the shortcut. If the feature is disabled, the event is not associated with the shortcut and the next event on the list is tried. The application uses the first event whose feature is enabled.

The state attribute indicates that the event is used by the shortcut only when the state of the shortcut object matches the value of this attribute.

The state-level attribute defines the state level (minimum, typical or maximum) that is added to the shortcut when the event is invoked. The expected value is a string that represents a fully-qualified class name - com.microstrategy.webapi.EnumWebPersistableState., followed by MINIMAL_STATE_INFO, TYPICAL_STATE_INFO, or MAXIMAL_STATE_INFO.

The XMLmerge_id  attribute is a unique identifier used by the upgrade utility rather than the application.

The <argument> element defines the name-value pair for a parameter that is passed to the parent event when the shortcut link is clicked by the user. It also represents an argument included in an event mapping definition.

The base-bean attribute indicates the bean from the pages bean hierarchy associated with the object. This bean is used in tasks such as resolving features. (If this attribute is not set, the application tries to use the base-bean attribute for the <event> element.)

If the value of the argument is taken from an enumerations value, the enum-name attribute represents the fully-qualified name of such a value.

The id attribute is a unique identifier for the argument.

The map-id attribute represents the id of the argument to which the element is mapped. (This attribute is used only for event mapping.)

The name attribute represents the fully-qualified name of the argument from the events enumeration interface.

The source attribute represents the source from which the arguments value is taken (for example, 'enum').

The sys-bean attribute represents the fully-qualified name of the beans class to which the base bean is cast when the value of the argument comes from a method name of the base bean.

The value attribute represents the value that is assigned to the argument. (If the value of this attribute is a method name of the base bean, you must set a value for the sys-bean attribute.)

Description

The <context-menu-list> element groups a list of context menus used by the application.

The name attribute defines the name of the context menu.

The model attribute defines the XML configuration file that should be used for the context menu.

The layouts attribute defines the layout definition  file that should be used for the context menu.

Description

The <ribbon-list-set> element groups all the ribbon lists used by the application.

The <ribbon-list> element groups all the ribbons used by the application.

The name attribute defines the name of the ribbon list.

The selectedToolbarPreference attribute retrieves the last toolbar that was clicked by the user.

The targetPath attribute retrieves the target to be checked by the ribbon for synchronization.

The name attribute defines the name of the ribbon.

The desc-id attribute provides the Resource Bundle item id that the application should use to display the name of the ribbon in the language of the user's locale.

The desc attribute provides a descriptor that the application should use to display the name of  the page if the desc-id attribute is missing.

The menu-model attribute defines the XML configuration file that should be used for the menu options.

The toolbar-model attribute defines the XML configuration file that should be used for the toolbar options.

The toolbar-layouts attribute defines the layout definition  file that should be used for the toolbar.

Description

The <browser-settings> element groups a list of browser settings objects, which define the cookies used by the application as name-value pairs.

If the browser settings are defined in a separate file, the config-src attribute tells the page configuration file the location of the browser settings configuration file.

If the browser settings are defined in a separate file, the version attribute indicates the release number of the browser settings configuration file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

The <browser-setting> element defines a single cookie used by the application and the default value to use if the setting for the cookie is missing.  

The desc attribute provides the description of how the browser setting is used by the application (for example, "Remove Jobs session flag" or "Report Grid - Pivot Buttons").

The name attribute defines the name of the cookie.

The value attribute defines the default value of the cookie. This value is used if the setting is missing, such as the first time that the cookie is used or after cookies have been deleted.

Description

The <system-pickers> element groups a list of shortcut list objects. These elements represent the system pickers of the application. System pickers appear as drop-down lists in a toolbar or in certain editors.   

If the system pickers are defined in a separate file, the config-src attribute tells the page configuration file the location of the system pickers configuration file.

If the system pickers are defined in a separate file, the version attribute indicates the release number of the system pickers configuration file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

Description

The <toolbars> element groups a list of shortcut list set objects. These <shortcut-list-set> elements define the toolbars used by the application.

If the toolbars are defined in a separate file, the config-src attribute tells the page configuration file the location of the toolbars configuration file.

If the toolbars are defined in a separate file, the version attribute indicates the release number of the toolbars configuration file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

Description

The <pages> element groups a list of page objects. These <page> elements represent the different pages that the application can display.

The <page> element represents a single page that the application can display.

When the allow-cancel attribute is set to 'true', the cookie is saved. When the allow-cancel attribute is set to 'false', the cookie is not saved and the page is not stored as the last successful page when rendered. When a new page executes a cancel event, the application will not display the page defined by this element, but any page previously rendered that allows canceling.

The binary-bean-display attribute indicates the page is a binary page and the value defines the name of the bean to be rendered.

The class attribute indicates the fully-qualified name of the page class that should be used if you do not want the PageComponentImpl class to be used.

The default attribute defines the default page of the application. There can be only one default page. This page is not displayed, but other pages can inherit its definition.

The desc attribute provides a descriptor that the application should use to display the name of  the page if the desc-id attribute is missing.

The desc-id attribute provides the Resource Bundle item id that the application should use to display the name of the page in the language of the user's locale.

The event-handler attribute indicates the fully-qualified name of the event handler class to be associated with the page.

The feature-id attribute represents a feature that is evaluated to determine whether the page should be rendered.

The login-required attribute indicates whether the page is rendered only if a valid session has been set.

The name attribute represents a unique identifier for the page.

The persist-mode attribute indicates whether the page persists the session's state. If the value of the attribute is set to '1', the page does not persist the session's state. If the value is set to '2', the session manager's state is saved to and restored from a preference. The value '4', persists the session manager's state in the HTTP request while the value '8' persists it in the session.

The track attribute indicates that the page can be saved as a return to page - in which case a subsequent page renders a link to this elements page.

The prototype attribute indicates that the page is inheriting all components and properties from the page specified as the value of the attribute.

Description

The <addons> element groups a list of add-on objects. These <addon> elements define a plug-in class that is executed when the page is executed.

If the add-ons are defined in a separate file, the config-src attribute tells the page configuration file the location of the add-ons definition file.

If the add-ons are defined in a separate file, the version attribute indicates the release number of the add-ons definition file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

The <addon> element defines a plug-in class that is executed along with the page.

The name attribute defines the fully-qualified name of the addons class.

The XMLmerge_id attribute provides a unique identifier for the add-on, which is used by the Update utility to merge changes.

This attribute is not required. However, when it is present, the value must be unique in the add-ons collection in order for the merge to work properly. If the value is not unique, no error is raised but only the last add-on with the same ID is used.

The <event-maps> element groups a list of event map objects. When an event map is defined in a page, if the event declared in the event map is handled, it can be transferred to a new event, a new source, or both.

If the event maps are defined in a separate file, the config-src attribute tells the page configuration file the location of the event maps definition file.

If the event maps are defined in a separate file, the version attribute indicates the release number of the event maps definition file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

When the <event-map> element is defined in a page, if the event declared in the event map is handled, it can be transferred to a new event, a new source, or both.

The id attribute is a unique identifier of the event from which to map.

The map-id attribute is a unique identifier of the event to which to map.

The target attribute indicates the bean that is responsible for handling the event.

The root-only attribute indicates whether the event is mapped only if the source of the event is the root of the beans hierarchy.

Description

The <javascripts> element groups a list of  <javascript> elements , which define output that can be executed by a <web:javascript> node.

If the <javascript> elements are defined in a separate file, the config-src attribute tells the page configuration file the location of the definition file.

If the <javascript> elements are defined in a separate file, the version attribute indicates the release number of the definition file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

The <javascript> element defines output that can be executed by a <web:javascript> node.

The base-bean attribute indicates the bean from the pages bean hierarchy associated with the JavaScript. This bean is used in tasks such as resolving features.

The event attribute provides the identifier that associates the <javascript> node with a <web:javascript> node. (The value of this attribute is compared to the value of the eventName attribute of the <web:javascript> node.)

The feature-id attribute represents a feature that is evaluated to determine whether the text defined by the javascript-code attribute  should be outputted to the browser.

The javascript-code attribute defines the text that is outputted to the browser.

The name attribute provides a unique identifier for the output that is produced.

The <templates> element groups a list of template objects. These <template> elements represent the jsp layout definitions to use based on the request status of the page (processing, successful, etc).

If the templates are defined in a separate file, the config-src attribute tells the page configuration file the location of the templates definition file.

If the templates are defined in a separate file, the version attribute indicates the release number of the templates definition file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

Description

The <template> element represents a single jsp layout definition to use based on the request status of the page (processing, successful, etc).

The error-desc attribute provides a descriptor used by the application, in case of an error, to display the screen caption for the Window when the error-title-id attribute is missing.

The error-title-id attribute provides the Resource Bundle item id used by the application, in case of an error, to display the screen caption for the Window in the language of the users locale.

The file-name attribute represents the name of a jsp file or http resource that defines the layout of the template.

The iframe attribute indicates whether the template can use the applications iframe infrastructure.

The show-wait attribute indicates whether the page displays the wait box when submitting a user's request to the Web server.

When the allow-cancel attribute is set to 'true', the cookie is saved. When the allow-cancel attribute is set to 'false', the page template is not stored as the last successful page when rendered. When a new page executes a cancel event, the application will not display the page template, but any page previously rendered that allows canceling.

The status attribute represents the fully-qualified name of the EnumRequestStatus interface value that determines the status of the page that is associated with the template.

The XMLmerge_id attribute is a unique identifier used by the upgrade utility rather than the application.

The <page-sections> element groups a list of page section objects. These <page-section> elements define JSP/ASP.NET inserts to be included in the template layout.

The use-default attribute indicates whether the page sections in the template inherit values from the page sections defined in the default page.

If the page sections are defined in a separate file, the config-src attribute tells the page configuration file the location of the page sections definition file.

If the page sections are defined in a separate file, the version attribute indicates the release number of the page sections definition file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

Description

The <page-section> element defines a single JSP/ASP.NET insert to be included in the template layout.

The file-name attribute indicates the name of the JSP/ASP.NET file to be inserted in the location on the page specified by the page section.

The name attribute provides a unique identifier for the page section.

The <web-components> element groups a list of Web component objects. These <web-component> elements pair up a bean with a style defined in the Style Catalog.

If the Web components are defined in a separate file, the config-src attribute tells the page configuration file the location of the Web components definition file.

If the Web components are defined in a separate file, the version attribute indicates the release number of the Web components definition file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

The <web-component> element pairs up a bean with a style defined in the Style Catalog.

The base-bean attribute indicates the bean from the pages bean hierarchy associated with the Web component. This bean is used in tasks such as resolving features.

Currently unused.

The feature-id attribute represents a feature that is evaluated to determine whether the Web component should be rendered.

The is-container attribute indicates whether the Web component contains other components. This attribute is used with iframe updates.

The name attribute provides a unique identifier for the Web component.

The status attribute indicates whether the web-component is refreshed when it is refreshed through the iframe.  If a value is specified for the status attribute, the web-component is refreshed if and only if the value of the status attribute corresponds to the status of the page. Valid values are those from the com.microstrategy.web.bean.EnumRequestStatus enumeration.

The style-name attribute indicates the name of the style that is used to render the bean, or the name of the preference where the style is stored.

The style-type attribute defines whether the style used to render the bean is taken directly from the style catalog or from the value of a preference.

The type attribute is used in conjunction with the subtype attribute. For example, if type='element' and subtype='menu', then a menu bar is rendered. The menu-definition is specified by a child <property> of the <web-component>, whose name attribute is set to 'dynamicMenuName' and whose value attribute is set to a properties list, such as 'rw-menus'.

The subtype attribute is used in conjunction with the type attribute. If the value of the subtype attribute is set to 'menu' and the value of the type attribute is set to 'element', the Web component represents a dynamic menu. The menu-definition is specified by a child <property> of the <web-component>, whose name attribute is set to 'dynamicMenuName' and whose value attribute is set to a properties list, such as 'rw-menus'.

Description

The <web-beans> element groups a list of Web bean objects. These <web-bean> elements represent the beans that is instantiated when the page is displayed.

If the Web beans are defined in a separate file, the config-src attribute tells the page configuration file the location of the Web beans definition file.

If the Web beans are defined in a separate file, the version attribute indicates the release number of the Web beans definition file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

The <web-bean> element represents a single bean that is instantiated when the page is displayed

The bean-class attribute indicates the fully-qualified name of the bean class associated with this <web-bean> element.

The bean-constructor attribute indicates the name of the constructor method to use when instantiating the bean associated with this <web-bean> element.

The event-handler attribute indicates the fully-qualified name of the event handler class to be associated with the bean.

The factory-class attribute indicates the fully-qualified name of a factory class  where the bean instance can be obtained.

The factory-constructor attribute indicates the name of the constructor method to use when instantiating the bean through a factory class.

The feature-id attribute represents a feature that is evaluated to determine whether the bean should be instantiated.

The name attribute provides a unique identifier for the Web bean.

The persist-mode attribute indicates where the bean's state is persisted. The values are taken from the EnumBeanPersistMode interface. If the value of the attribute is set to '1', the page does not persist the bean's state. If the value is set to '2', the bean's state is persisted as a preference. The value '4', persists the bean's state in the HTTP request while the value '8' persists it in the session.

The sys-bean attribute represents the name of the bean type, taken from the EnumSysBeanNames interface.

The use-default attribute indicates that the bean definition inherits from the default page.

Description

The <event-handlers> element groups a list of event handler objects, which each define an event handler to be associated with the parent bean.

If the event handlers are defined in a separate file, the config-src attribute tells the page configuration file the location of the event handlers definition file.

If the event handlers are defined in a separate file, the version attribute indicates the release number of the event handlers definition file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

The <event-handler> element defines a single event handler associated with the parent bean.

The class-name attribute indicates the fully-qualified name of the event handler class to be associated with the bean.

The <init-properties> element groups a list of initialization property objects. These <property> elements represent name-value pairs of properties to be set in the beans instance immediately after the bean is created.

If the initialization properties are defined in a separate file, the config-src attribute tells the page configuration file the location of the initialization properties definition file.

If the initialization properties are defined in a separate file, the version attribute indicates the release number of the initialization properties definition file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

The <request-properties> element groups a list of request property objects. These <property>elements represent name-value pairs of properties to be set in the beans instance after the beans state is restored.

If the request properties are defined in a separate file, the config-src attribute tells the page configuration file the location of the request properties definition file.

If the request  properties are defined in a separate file, the version attribute indicates the release number of the request properties definition file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

The <styles> element groups a list of style objects. These <style> elements modify a style from the Style Catalog using formal parameter values specified in their child <property> elements.

If the styles are defined in a separate file, the config-src attribute tells the page configuration file the location of the styles definition file.

If the styles are defined in a separate file, the version attribute indicates the release number of the styles definition file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

Description

The <style> element modifies the definition of a style from the Style Catalog using formal parameter values specified in the child <property> elements. The modified style is added to the parent bean when the bean is first instantiated.

The name attribute provides the name of the style (from the Style Catalog styles collection) to be redefined using the formal parameter values specified in the child <property> elements. (If a value has also been set for the preference attribute, that style is used rather than the one specified by this attribute.)

The preference attribute provides the name of the style (from the Style Catalog styles collection), as specified by the user, to be redefined using the formal parameter values specified in the child <property> elements. (When values have been set for both the name attribute and the preference attribute, the name of the style to be added to the bean will always come from the preference attribute.)

The transform-class attribute redefines the style by associating a new transform class to it. The value is the fully-qualified name of the transforms class.

The <properties> element groups a list of property objects. These  <property> elements each represent a name-value pair of formal parameters set to a style definition.  They also represent the properties set to an add-on class.

If the properties are defined in a separate file, the config-src attribute tells the page configuration file the location of the properties definition file.

If the properties are defined in a separate file, the version attribute indicates the release number of the properties definition file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

The <property> element represents the name-value pair of a formal parameter set to a style definition or a property in an add-on.  

The feature-id attribute represents a feature that is evaluated to determine whether the formal parameter or add-on property should be set.

The name attribute represents the name of the formal parameter or add-on property.

The source attribute indicates where the value of the formal parameter or add-on property is set.

The type attribute indicates the data type of the formal parameter or add-on property. If the attribute is set to 'flag', the value is added rather than set to the formal parameter or add-on property.