Browser configuration schema reference

Article
10/26/2015

Browser configuration files (also known as browserconfig) can be used to define pinned site customizations, such as tile backgrounds, badge updates, and tile notifications. Browser configuration files let you set these customizations using external XML files rather than metadata within the HTML markup of a webpage.

Here, you'll find the elements supported by the browser configuration schema. (If you're looking for information regarding tile, toast, or badge schema, see Tile, toast, and badge schema reference.)

Defining notifications with browser configuration schema
Required elements
Specifying tile images and assets
Defining badge polling
Defining notification polling
Related topics

Defining notifications with browser configuration schema

Browser configuration files are XML files that define customizations for pinned sites and Uniform Resource Identifiers (URIs) to be polled for notification updates. (You can also use HTML or JavaScript to define notifications.)

Here's a sample browser configuration file:

<?xml version="1.0" encoding="utf-8"?>
<browserconfig>
   <msapplication>
     <tile>
        <square70x70logo src="small.png"/>
        <square150x150logo src="medium.png"/>
        <wide310x150logo src="wide.png"/>
        <square310x310logo src="large.png"/>
        <TileColor>#009900</TileColor>
     </tile>
     <badge>
        <polling-uri src="badge.xml"/>
        <frequency>30</frequency>
     </badge>
     <notification>
        <polling-uri  src="1.xml"/>
        <polling-uri2 src="2.xml"/>
        <polling-uri3 src="3.xml"/>
        <polling-uri4 src="4.xml"/>
        <polling-uri5 src="5.xml"/>
        <frequency>30</frequency>
        <cycle>1</cycle>
     </notification>
   </msapplication>
</browserconfig>

This example defines tile backgrounds for four tile sizes, specifies a badge update for every thirty (30) minutes, and defines five notification URIs to be polled every half hour. Because this example contains relative references, the files for the images and the notification polls are presumed to be located in the same directory as the configuration file itself. (For best results, use absolute (fully-qualified) paths.)

To use the configuration file, use HTML:

<meta name="msapplication-config" content="IEconfig.xml" />

To stop using the configuration file, set the content attribute to "none":

 <meta name="msapplication-config" content="none"/>

Note: If a webpage does not specify a browser configuration file, IE11 automatically looks for "browserconfig.xml" in the root directory of the server. To prevent this, use an "msapplication-config" header with the content attribute to "none" (shown earlier).

For more info, see:

Required elements

In addition to the xml prolog, browser configuration files require the following two elements:

Element Description

browserconfig

The root element of the configuration file. Required.

Example:

<browserconfig>

msapplication

A vendor specific element that defines the type of application the file applies to (pinned sites). This element is required must be declared as a child element of the browserconfig element.

Example:

<msapplication>

Neither element supports attributes.

Specifying tile images and assets

If specified, the tile element defines the images and color assets for the pinned site tiles.

The following elements are supported as child elements for the tile element:

Element	Description
square70x70logo	Use the src attribute to define the image filename for the small tile. Example: `<square70x70logo src="imagefilename" />`
square150x150logo	Use the src attribute to define the image filename for the medium tile. Example: `<square150x150logo src="imagefilename" />`
wide310x150logo	Use the src attribute to define the image filename for the wide tile. Example: `<wide310x150logo src="imagefilename" />`
square310x310logo	Use the src attribute to define the image filename for the large tile. Example: `<square310x310logo src="imagefilename" />`
TileImage	Use the src attribute to define the image filename for the medium tile. (Note that square150x150logo is preferred.) Example: `<TileImage src="imagefilename" />`
TileColor	Defines the color for the tile. Example: `<TileColor>#009900</TileColor>`

Note Element names are case sensitive and must be specified using the case shown.

Defining badge polling

If specified, the badge element defines a URI to be polled repeatedly. The URIshould point to an XML file containing badge notification markup.

The following elements are supported as child elements for the badge element:

Element Description

polling-uri

Use the src attribute to define the filename for badge markup.

Example:

<polling-uri src="badge.xml"/>

frequency

Defines the frequency, in minutes, between poll requests. Must be one of the following values: 30, 60, 360, 720, or 1440.

Example:

<frequency>30</frequency>

Defining notification polling

If specified, the notification element defines up to five different URIs to be polled for notification markup. Each defined URIshould point to an XML file containing tile markup.

The following elements are supported as child elements for the notification element:

Element	Description
polling-uri	Use the src attribute to define the of the first notification markup file. Example: `<polling-uri src="1.xml" />`
polling-uri2	Use the src attribute to define the of the second notification markup file. Example: `<polling-uri2 src="2.xml" />`
polling-uri3	Use the src attribute to define the of the third notification markup file. Example: `<polling-uri3 src="3.xml" />`
polling-uri4	Use the src attribute to define the of the fourth notification markup file. Example: `<polling-uri4 src="4.xml" />`
polling-uri5	Use the src attribute to define the of the fifth notification markup file. Example: `<polling-uri5 src="5.xml" />`
frequency	Defines the frequency, in minutes, between poll requests. Must be one of the following values: 30, 60, 360, 720, or 1440. Example: `<frequency>30</frequency>`
cycle	Control notification cycling. Must be one of the following values: 0: (default if there's only one notification) No tiles show notifications. 1: (default if there are multiple notifications) Notifications cycle for all tile sizes. 2: Notifications cycle for medium tiles only. 3: Notifications cycle for wide tiles only. 4: Notifications cycle for large tiles only. 5: Notifications cycle for medium and wide tiles. 6: Notifications cycle for medium and large tiles. 7: Notifications cycle for large and wide tiles. Example: `<cycle>1</cycle>`