WebTemplate element (Upgrade)

Applies to: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

Contains the site template upgrade definition.

<WebTemplate
  BeginFromSchemaVersion = "Integer"
  EndFromSchemaVersion = "Integer"
  FromProductVersion = "Integer"
  ID = "Integer"
  LocaleId = "Integer"
  RemoveSiteExternalSecurityProvider = "true | "false"
  ToSchemaVersion = "Integer">
    ...
  <Lists>
    ...
  </Lists>
  <Files>
    ...
  </Files>
  <AppliedWebFeatures>
    ...
  </AppliedWebFeatures>
</WebTemplate>

Elements and attributes

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute Description
BeginFromSchemaVersion
Optional Integer. Specifies the starting point of a schema version range to which this upgrade definition applies.
EndFromSchemaVersion
Optional Integer. Specifies the end of a schema version range to which this upgrade definition applies.
FromProductVersion
Optional Integer. Specifies the product version of the original site definition to which this upgrade definition applies.
ID
Required Integer. Specifies the identifier (ID) of the site definition to be upgraded. This value corresponds to the ID attribute of the Template element.
LocaleId
Optional Integer. Specifies the locales to which the site upgrade definition applies. Set to * to imply that the definition applies to all site definition upgrades. Microsoft SharePoint Foundation implements only one upgrade definition per locale. If * is specified and a locale-specific upgrade definition exists, SharePoint Foundation uses the locale-specific upgrade definition. If the locale-specific definition does not exist, SharePoint Foundation falls back to the * upgrade definition.
RemoveSiteExternalSecurityProvider
Optional Boolean. True to exclude any external security provider from the upgrade; otherwise, False.
ToSchemaVersion
Optional Integer. Specifies the product version to which the site definition is upgraded.

Child elements

Parent elements

Occurrences

  • Minimum: 1
  • Maximum: Unbounded

Example

For an example of how this element is used, see Upgrade Definition schema.