Folder Page Mapping Configuration File XML Structure

By default, folder page mapping configuration settings are set within pageConfig.xml, but they can also be set in a separate configuration file. A folder page mapping configuration file would include a series of folder mapping definitions, which would each define the default page that the application would use to display the contents of a specific metadata project folder.

The recommended practice is to use a separate configuration file to ensure that your customizations are correctly propagated in future upgrades. You use the same XML structure, regardless of whether you make the settings in pageConfig.xml or in a separate configuration file.

A sample of the XML structure for a separate configuration file and the folder mapping section of pageConfig.xml are shown below, followed by a description of the elements and attributes used in these files.

XML structure (separatefolder page mapping configuration file)

<folderpage-mapping>

...

</folderpage-mapping>

XML structure (pageConfig.xml)

<folderpage-mapping>

...

</folderpage-mapping>

Description

The table below describes the XML structure of the page mapping configuration file. The four columns in the table include the following descriptive information:

Parent Element Child Element 1 Child Element 2	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.
Number of Nodes	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").
Parent Element Attributes	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 <folderpage-mapping> 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.
Description	Describes either a parent element in the Parent Element column or an attribute in the Parent Element Attributescolumn.

Parent Element Child Element 1 Child Element 2	Number of Nodes	Parent Element Attributes	Description
<folderpage-mapping> <mapping>	1		The <folderpage-mapping> 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.
		config-src (cdata / implied)	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.
		version (nmtoken / implied)	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.
<mapping>	1 or more		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.
		target-page (nmtoken / required)	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.
		named-page (cdata / required)	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").