Folder Links 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 config-src attribute for the <folder-links> element has an attribute type of "cdata" (character data) and is implied. The id attribute for the <context> element has an attribute type of "nmtoken" (name token) and is required.

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

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. (When you use a separate configuration file, the <folder-links> element represents the root element of the file.)

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 system folder shortcuts on a project basis. It is found inside a context and can be used to determine which folder shortcuts should appear in browsers in which MicroStrategy projects. System folder 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 folder links, or shortcuts, defined inside this <project> element appear in all projects.

The <folder-link> element defines a shortcut to a system 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 system 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 versions of the product.

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 versions of the product.

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.