Browser Settings Configuration File XML Structure

The browser settings configuration file groups a list of browser setting objects, which define the browser settings used by the application.

Browser configuration settings are generally set in the browserSettings.xml file, but they can also be made within pageConfig.xml. 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 whether you make the settings in browserSettings.xml or in pageConfig.xml.

A sample of the XML structure for browserSettings.xml is shown below, followed by a description of the elements and attributes that make up the file.

XML structure

<browser-settings version="1.0">

<browser-setting desc="Cancel Request session flag" name="cr" value="1"/>

<browser-setting desc="Remove Jobs session flag" name="rj" value="0"/>

<browser-setting desc="Language" name="locale" value="0000"/>

<browser-setting desc="Locale for numbers and date format" name="sLoc" value="0000"/>

<browser-setting desc="Report Frame Formatting Toolbar" name="ft" value="0"/>

...

</browser-settings>

Description

The table below describes the XML structure of the browser settings 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 <browser-settings> element has an attribute type of "nmtoken" (name token) and is implied. The name attribute for the <browser-setting> 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
<browser-settings> - <browser-setting>	1		The <browser-settings> element groups a list of browser settings objects. These <browser-setting> elements define the cookies used by the application as name-value pairs. (When you use a separate browser settings configuration file, the <browser-settings> element represents the root element of the file.)
		config-src (cdata / implied)	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.
		version (nmtoken / implied)	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.
<browser-setting>	1 or more		The <browser-setting> element defines a single cookie used by the application and the default value to be used if the setting is missing. (For example, in the sample XML code above, the cookie whose name is 'cr' uses a default value of '1' if the cookie has not already been saved.)
		desc (cdata / implied)	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").
		name (cdata / required)	The name attribute defines the name of the cookie.
		value (cdata / required)	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.