Skip to content

Latest commit

 

History

History
1411 lines (1051 loc) · 39.6 KB

ProvisioningSchema-2015-05.md

File metadata and controls

1411 lines (1051 loc) · 39.6 KB
Raw

PnP Provisioning Schema

Topic automatically generated on 8/24/2015

Namespace

The namespace of the PnP Provisioning Schema is:

http://schemas.dev.office.com/PnP/2015/05/ProvisioningSchema

All the elements have to be declared with that namespace reference.

Root Elements

Here follows the list of root elements available in the PnP Provisioning Schema.

Provisioning

<pnp:Provisioning
      xmlns:pnp="http://schemas.dev.office.com/PnP/2015/05/ProvisioningSchema">
   <pnp:Preferences />
   <pnp:Templates />
   <pnp:Sequence />
   <pnp:ImportSequence />
</pnp:Provisioning>

Here follow the available child elements for the Provisioning element.

Element Type Description
Preferences Preferences The mandatory section of preferences for the current provisioning definition.
Templates Templates An optional section made of provisioning templates.
Sequence Sequence An optional section made of provisioning sequences, which can include Sites, Site Collections, Taxonomies, Provisioning Templates, etc.
ImportSequence ImportSequence Imports sequences from an external file. All current properties should be sent to that file.

ProvisioningTemplate

Represents the root element of the SharePoint Provisioning Template

<pnp:ProvisioningTemplate
      xmlns:pnp="http://schemas.dev.office.com/PnP/2015/05/ProvisioningSchema"
      ID="xsd:ID"
      Version="xsd:decimal">
   <pnp:SitePolicy />
   <pnp:PropertyBagEntries />
   <pnp:Security />
   <pnp:SiteFields />
   <pnp:ContentTypes />
   <pnp:Lists />
   <pnp:Features />
   <pnp:CustomActions />
   <pnp:Files />
   <pnp:Pages />
   <pnp:TermGroups />
   <pnp:ComposedLook />
   <pnp:Providers />
</pnp:ProvisioningTemplate>

Here follow the available child elements for the ProvisioningTemplate element.

Element Type Description
SitePolicy xsd:string The Site Policy of the Provisioning Template, optional element
PropertyBagEntries PropertyBagEntries The Property Bag entries of the Provisioning Template, optional collection of elements
Security Security The Security Groups Members of the Provisioning Template, optional collection of elements
SiteFields SiteFields The Site Columns of the Provisioning Template, optional element
ContentTypes ContentTypes The Content Types of the Provisioning Template, optional element
Lists Lists The Lists instances of the Provisioning Template, optional element
Features Features The Features (Site or Web) to activate or deactivate while applying the Provisioning Template, optional collection of elements
CustomActions CustomActions The Custom Actions (Site or Web) to provision with the Provisioning Template, optional element
Files Files The Files to provision into the target Site through the Provisioning Template, optional element
Pages Pages The Pages to provision into the target Site through the Provisioning Template, optional element
TermGroups TermGroups The TermGroups element allows provisioning one or more TermGroups into the target Site, optional element
ComposedLook ComposedLook The ComposedLook for the Provisioning Template, optional element
Providers Providers The Extensiblity Providers to invoke while applying the Provisioning Template, optional collection of elements

Here follow the available attributes for the ProvisioningTemplate element.

Attibute Type Description
ID xsd:ID The ID of the Provisioning Template, required attribute
Version xsd:decimal The Version of the Provisioning Template, required attribute

Child Elements and Complex Types

Here follows the list of all the other child elements and complex types that can be used in the PnP Provisioning Schema.

Preferences

General settings for a Provisioning file.

<pnp:Preferences
      Version="xsd:string"
      Author="xsd:string"
      Generator="xsd:string">
   <pnp:Parameters />
</pnp:Preferences>

Here follow the available child elements for the Preferences element.

Element Type Description
Parameters Parameters Definition of parameters that can be used as replacement within templates and provisioning objects.

Here follow the available attributes for the Preferences element.

Attibute Type Description
Version xsd:string Optional version number.
Author xsd:string Optional Author name
Generator xsd:string Optional Name of tool generating this file

Parameters

Definition of parameters that can be used as replacement within templates and provisioning objects.

<pnp:Parameters>
   <pnp:Parameter />
</pnp:Parameters>

Here follow the available child elements for the element.

Element Type Description
Parameter Parameter A Parameter that can be used as a replacement within templates and provisioning objects.

Templates

SharePoint Templates, which can be inline or references to external files

<pnp:Templates
      ID="xsd:ID">
   <pnp:ProvisioningTemplateFile />
   <pnp:ProvisioningTemplateReference />
   <pnp:ProvisioningTemplate />
</pnp:Templates>

Here follow the available child elements for the Templates element.

Element Type Description
ProvisioningTemplateFile ProvisioningTemplateFile Reference to an external template file, which will be based on the current schema but will focus only on the SharePointProvisioningTemplate section.
ProvisioningTemplateReference ProvisioningTemplateReference Reference to another template by ID.
ProvisioningTemplate ProvisioningTemplate

Here follow the available attributes for the Templates element.

Attibute Type Description
ID xsd:ID A unique identifier of the Templates collection, optional attribute

PropertyBagEntries

The Property Bag entries of the Provisioning Template, optional collection of elements

<pnp:PropertyBagEntries>
   <pnp:PropertyBagEntry />
</pnp:PropertyBagEntries>

Here follow the available child elements for the element.

Element Type Description
PropertyBagEntry PropertyBagEntry

Security

The Security Groups Members of the Provisioning Template, optional collection of elements

<pnp:Security>
   <pnp:AdditionalAdministrators />
   <pnp:AdditionalOwners />
   <pnp:AdditionalMembers />
   <pnp:AdditionalVisitors />
</pnp:Security>

Here follow the available child elements for the element.

Element Type Description
AdditionalAdministrators UsersList List of additional Administrators for the Site, optional collection of elements
AdditionalOwners UsersList List of additional Owners for the Site, optional collection of elements
AdditionalMembers UsersList List of additional Members for the Site, optional collection of elements
AdditionalVisitors UsersList List of additional Visitors for the Site, optional collection of elements

SiteFields

The Site Columns of the Provisioning Template, optional element

<pnp:SiteFields>
   <!-- Any other XML content -->
</pnp:SiteFields>

ContentTypes

The Content Types of the Provisioning Template, optional element

<pnp:ContentTypes>
   <pnp:ContentType />
</pnp:ContentTypes>

Here follow the available child elements for the element.

Element Type Description
ContentType ContentType

Lists

The Lists instances of the Provisioning Template, optional element

<pnp:Lists>
   <pnp:ListInstance />
</pnp:Lists>

Here follow the available child elements for the element.

Element Type Description
ListInstance ListInstance

Features

The Features (Site or Web) to activate or deactivate while applying the Provisioning Template, optional collection of elements

<pnp:Features>
   <pnp:SiteFeatures />
   <pnp:WebFeatures />
</pnp:Features>

Here follow the available child elements for the element.

Element Type Description
SiteFeatures FeaturesList The Site Features to activate or deactivate while applying the Provisioning Template, optional collection of elements
WebFeatures FeaturesList The Web Features to activate or deactivate while applying the Provisioning Template, optional collection of elements

CustomActions

The Custom Actions (Site or Web) to provision with the Provisioning Template, optional element

<pnp:CustomActions>
   <pnp:SiteCustomActions />
   <pnp:WebCustomActions />
</pnp:CustomActions>

Here follow the available child elements for the element.

Element Type Description
SiteCustomActions CustomActionsList The Site Custom Actions to provision while applying the Provisioning Template, optional element
WebCustomActions CustomActionsList The Web Custom Actions to provision while applying the Provisioning Template, optional element

Files

The Files to provision into the target Site through the Provisioning Template, optional element

<pnp:Files>
   <pnp:File />
</pnp:Files>

Here follow the available child elements for the element.

Element Type Description
File File

Pages

The Pages to provision into the target Site through the Provisioning Template, optional element

<pnp:Pages>
   <pnp:Page />
</pnp:Pages>

Here follow the available child elements for the element.

Element Type Description
Page Page

TermGroups

The TermGroups element allows provisioning one or more TermGroups into the target Site, optional element

<pnp:TermGroups>
   <pnp:TermGroup />
</pnp:TermGroups>

Here follow the available child elements for the element.

Element Type Description
TermGroup TermGroup The TermGroup element to provision into the target Site through the Provisioning Template, optional element

Providers

The Extensiblity Providers to invoke while applying the Provisioning Template, optional collection of elements

<pnp:Providers>
   <pnp:Provider />
</pnp:Providers>

Here follow the available child elements for the element.

Element Type Description
Provider Provider

PropertyBagEntry

A property bag entry

<pnp:PropertyBagEntry
      Indexed="xsd:boolean">
</pnp:PropertyBagEntry>

Here follow the available attributes for the PropertyBagEntry element.

Attibute Type Description
Indexed xsd:boolean

StringDictionaryItem

Defines a StringDictionary element

<pnp:StringDictionaryItem
      Key="xsd:string"
      Value="xsd:string">
</pnp:StringDictionaryItem>

Here follow the available attributes for the StringDictionaryItem element.

Attibute Type Description
Key xsd:string The Key of the property to store in the StringDictionary, required attribute
Value xsd:string The Value of the property to store in the StringDictionary, required attribute

UsersList

List of Users for the Site Security, collection of elements

<pnp:UsersList>
   <pnp:User />
</pnp:UsersList>

Here follow the available child elements for the UsersList element.

Element Type Description
User User

User

The base abstract type for a User element

<pnp:User
      Name="xsd:string">
</pnp:User>

Here follow the available attributes for the User element.

Attibute Type Description
Name xsd:string The Name of the User, required attribute

ListInstance

Defines a ListInstance element

<pnp:ListInstance
      Title="xsd:string"
      Description="xsd:string"
      DocumentTemplate="xsd:string"
      OnQuickLaunch="xsd:boolean"
      TemplateType="xsd:int"
      Url="xsd:string"
      EnableVersioning="xsd:boolean"
      EnableMinorVersions="xsd:boolean"
      EnableModeration="xsd:boolean"
      MinorVersionLimit="xsd:int"
      MaxVersionLimit="xsd:int"
      DraftVersionVisibility="xsd:int"
      RemoveExistingContentTypes="xsd:boolean"
      TemplateFeatureID="pnp:GUID"
      ContentTypesEnabled="xsd:boolean"
      Hidden="xsd:boolean"
      EnableAttachments="xsd:boolean"
      EnableFolderCreation="xsd:boolean">
   <pnp:ContentTypeBindings />
   <pnp:Views />
   <pnp:Fields />
   <pnp:FieldRefs />
   <pnp:DataRows />
</pnp:ListInstance>

Here follow the available child elements for the ListInstance element.

Element Type Description
ContentTypeBindings ContentTypeBindings The ContentTypeBindings entries of the List Instance, optional collection of elements
Views Views The Views entries of the List Instance, optional collection of elements
Fields Fields The Fields entries of the List Instance, optional collection of elements
FieldRefs FieldRefs The FieldRefs entries of the List Instance, optional collection of elements
DataRows DataRows

Here follow the available attributes for the ListInstance element.

Attibute Type Description
Title xsd:string The Title of the List Instance, required attribute
Description xsd:string The Description of the List Instance, optional attribute
DocumentTemplate xsd:string The DocumentTemplate of the List Instance, optional attribute
OnQuickLaunch xsd:boolean The OnQuickLaunch flag for the List Instance, optional attribute
TemplateType xsd:int The TemplateType of the List Instance, required attribute Values available here: https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.client.listtemplatetype.aspx
Url xsd:string The Url of the List Instance, required attribute
EnableVersioning xsd:boolean The EnableVersioning flag for the List Instance, optional attribute
EnableMinorVersions xsd:boolean The EnableMinorVersions flag for the List Instance, optional attribute
EnableModeration xsd:boolean The EnableModeration flag for the List Instance, optional attribute
MinorVersionLimit xsd:int The MinorVersionLimit for versions history for the List Instance, optional attribute
MaxVersionLimit xsd:int The MaxVersionLimit for versions history for the List Instance, optional attribute
DraftVersionVisibility xsd:int The DraftVersionVisibility for the List Instance, optional attribute. The property will be cast to enum DraftVersionVisibility 0 - Reader - Any user who can read items, 1 - Author - Only users who can edit items, 2 - Approver - Only users who can approve items (and the author of the item)
RemoveExistingContentTypes xsd:boolean The RemoveExistingContentTypes flag for the List Instance, optional attribute
TemplateFeatureID GUID The TemplateFeatureID for the feature on which the List Instance is based, optional attribute
ContentTypesEnabled xsd:boolean The ContentTypesEnabled flag for the List Instance, optional attribute
Hidden xsd:boolean The Hidden flag for the List Instance, optional attribute
EnableAttachments xsd:boolean The EnableAttachments flag for the List Instance, optional attribute
EnableFolderCreation xsd:boolean The EnableFolderCreation flag for the List Instance, optional attribute

ContentTypeBindings

The ContentTypeBindings entries of the List Instance, optional collection of elements

<pnp:ContentTypeBindings>
   <pnp:ContentTypeBinding />
</pnp:ContentTypeBindings>

Here follow the available child elements for the element.

Element Type Description
ContentTypeBinding ContentTypeBinding

Views

The Views entries of the List Instance, optional collection of elements

<pnp:Views
      RemoveExistingViews="xsd:boolean">
   <!-- Any other XML content -->
</pnp:Views>

Here follow the available attributes for the element.

Attibute Type Description
RemoveExistingViews xsd:boolean A flag to declare if the existing views of the List Instance have to be removed, befire adding the custom views, optional attribute

Fields

The Fields entries of the List Instance, optional collection of elements

<pnp:Fields>
   <!-- Any other XML content -->
</pnp:Fields>

FieldRefs

The FieldRefs entries of the List Instance, optional collection of elements

<pnp:FieldRefs>
   <pnp:FieldRef />
</pnp:FieldRefs>

Here follow the available child elements for the element.

Element Type Description
FieldRef ListInstanceFieldRef

DataRows

<pnp:DataRows>
   <pnp:DataRow />
</pnp:DataRows>

Here follow the available child elements for the element.

Element Type Description
DataRow DataRow

DataValue

The DataValue of a single field of a row to insert into a target ListInstance

<pnp:DataValue
      FieldName="xsd:string">
</pnp:DataValue>

Here follow the available attributes for the DataValue element.

Attibute Type Description
FieldName xsd:string

ContentType

Defines a content type

<pnp:ContentType
      ID="pnp:ContentTypeId"
      Name="xsd:string"
      Description="xsd:string"
      Group="xsd:string"
      Hidden="xsd:boolean"
      Sealed="xsd:boolean"
      ReadOnly="xsd:boolean"
      Overwrite="xsd:boolean">
   <pnp:FieldRefs />
   <pnp:DocumentTemplate />
</pnp:ContentType>

Here follow the available child elements for the ContentType element.

Element Type Description
FieldRefs FieldRefs The FieldRefs entries of the List Instance, optional collection of elements
DocumentTemplate DocumentTemplate Specifies the document template for the content type. This is the file which SharePoint Foundation opens as a template when a user requests a new item of this content type.

Here follow the available attributes for the ContentType element.

Attibute Type Description
ID ContentTypeId The value of the content type ID, required attribute
Name xsd:string The name of the content type, required attribute
Description xsd:string The description of the content type, optional attribute
Group xsd:string The group of the content type, optional attribute
Hidden xsd:boolean Optional Boolean. True to define the content type as hidden. If you define a content type as hidden, SharePoint Foundation does not display that content type on the New button in list views.
Sealed xsd:boolean Optional Boolean. True to prevent changes to this content type. You cannot change the value of this attribute through the user interface, but you can change it in code if you have sufficient rights. You must have site collection administrator rights to unseal a content type.
ReadOnly xsd:boolean Optional Boolean. TRUE to specify that the content type cannot be edited without explicitly removing the read-only setting. This can be done either in the user interface or in code.
Overwrite xsd:boolean Optional Boolean. TRUE to overwrite an existing content type with the same ID.

FieldRefs

The FieldRefs entries of the List Instance, optional collection of elements

<pnp:FieldRefs>
   <pnp:FieldRef />
</pnp:FieldRefs>

Here follow the available child elements for the element.

Element Type Description
FieldRef ContentTypeFieldRef

DocumentTemplate

Specifies the document template for the content type. This is the file which SharePoint Foundation opens as a template when a user requests a new item of this content type.

<pnp:DocumentTemplate
      TargetName="xsd:string">
</pnp:DocumentTemplate>

Here follow the available attributes for the element.

Attibute Type Description
TargetName xsd:string The value of the content type ID, required attribute

ContentTypeBinding

Defines the binding between a ListInstance and a ContentType

<pnp:ContentTypeBinding
      ContentTypeID="pnp:ContentTypeId"
      Default="xsd:boolean">
</pnp:ContentTypeBinding>

Here follow the available attributes for the ContentTypeBinding element.

Attibute Type Description
ContentTypeID ContentTypeId The value of the ContentTypeID to bind, required attribute
Default xsd:boolean Declares if the Content Type should be the default Content Type in the list or library, optional attribute

FeaturesList

Defines a collection of elements of type Feature

<pnp:FeaturesList>
   <pnp:Feature />
</pnp:FeaturesList>

Here follow the available child elements for the FeaturesList element.

Element Type Description
Feature Feature

Feature

Defines a single Site or Web Feature, which will be activated or deactivated while applying the Provisioning Template

<pnp:Feature
      ID="pnp:GUID"
      Deactivate="xsd:boolean"
      Description="xsd:string">
</pnp:Feature>

Here follow the available attributes for the Feature element.

Attibute Type Description
ID GUID The unique ID of the Feature, required attribute
Deactivate xsd:boolean Defines if the feature has to be deactivated or activated while applying the Provisioning Template, optional attribute
Description xsd:string The Description of the feature, optional attribute

ListInstanceFieldRef

Defines the binding between a ListInstance and a Field

<pnp:ListInstanceFieldRef
      ID="pnp:GUID"
      Name="xsd:string"
      Required="xsd:boolean"
      Hidden="xsd:boolean"
      DisplayName="xsd:string">
</pnp:ListInstanceFieldRef>

Here follow the available attributes for the ListInstanceFieldRef element.

Attibute Type Description
ID GUID The value of the field ID to bind, required attribute
Name xsd:string The name of the field used in the field reference. This is for reference/readibility only.
Required xsd:boolean The Required flag for the field to bind, optional attribute
Hidden xsd:boolean The Hidden flag for the field to bind, optional attribute
DisplayName xsd:string The display name of the field to bind, only applicable to fields that will be added to lists, optional attribute

ContentTypeFieldRef

Defines the binding between a ContentType and a Field

<pnp:ContentTypeFieldRef
      ID="pnp:GUID"
      Name="xsd:string"
      Required="xsd:boolean"
      Hidden="xsd:boolean">
</pnp:ContentTypeFieldRef>

Here follow the available attributes for the ContentTypeFieldRef element.

Attibute Type Description
ID GUID The value of the field ID to bind, required attribute
Name xsd:string The name of the field used in the field reference. This is for reference/readibility only.
Required xsd:boolean The Required flag for the field to bind, optional attribute
Hidden xsd:boolean The Hidden flag for the field to bind, optional attribute

CustomActionsList

Defines a collection of elements of type CustomAction

<pnp:CustomActionsList>
   <pnp:CustomAction />
</pnp:CustomActionsList>

Here follow the available child elements for the CustomActionsList element.

Element Type Description
CustomAction CustomAction

CustomAction

Defines a Custom Action, which will be provisioned while applying the Provisioning Template

<pnp:CustomAction
      Name="xsd:string"
      Description="xsd:string"
      Group="xsd:string"
      Location="xsd:string"
      Title="xsd:string"
      Sequence="xsd:int"
      Rights="xsd:int"
      Url="xsd:string"
      Enabled="xsd:boolean"
      ScriptBlock="xsd:string"
      ImageUrl="xsd:string"
      ScriptSrc="xsd:string">
   <pnp:CommandUIExtension />
</pnp:CustomAction>

Here follow the available child elements for the CustomAction element.

Element Type Description
CommandUIExtension CommandUIExtension Defines the Custom UI Extension XML, optional element.

Here follow the available attributes for the CustomAction element.

Attibute Type Description
Name xsd:string The Name of the CustomAction, required attribute
Description xsd:string The Description of the CustomAction, optional attribute
Group xsd:string The Group of the CustomAction, optional attribute
Location xsd:string The Location of the CustomAction, required attribute
Title xsd:string The Title of the CustomAction, required attribute
Sequence xsd:int The Sequence of the CustomAction, optional attribute
Rights xsd:int The Rights for the CustomAction, based on values from Microsoft.SharePoint.Client.BasePermissions, optional attribute
Url xsd:string The URL of the CustomAction, optional attribute
Enabled xsd:boolean The Enabled flag for the CustomAction, optional attribute
ScriptBlock xsd:string The ScriptBlock of the CustomAction, optional attribute
ImageUrl xsd:string The ImageUrl of the CustomAction, optional attribute
ScriptSrc xsd:string The ScriptSrc of the CustomAction, optional attribute

CommandUIExtension

Defines the Custom UI Extension XML, optional element.

<pnp:CommandUIExtension>
   <!-- Any other XML content -->
</pnp:CommandUIExtension>

FileProperties

A collection of File Properties

<pnp:FileProperties>
   <pnp:Property />
</pnp:FileProperties>

Here follow the available child elements for the FileProperties element.

Element Type Description
Property StringDictionaryItem

File

Defines a File element, to describe a file that will be provisioned into the target Site

<pnp:File
      Src="xsd:string"
      Folder="xsd:string"
      Overwrite="xsd:boolean">
   <pnp:Properties />
   <pnp:WebParts />
</pnp:File>

Here follow the available child elements for the File element.

Element Type Description
Properties FileProperties The File Properties, optional collection of elements
WebParts WebParts The webparts to add to the page, optional collection of elements

Here follow the available attributes for the File element.

Attibute Type Description
Src xsd:string The Src of the File, required attribute
Folder xsd:string The TargetFolder of the File, required attribute
Overwrite xsd:boolean The Overwrite flag for the File, optional attribute

WebParts

The webparts to add to the page, optional collection of elements

<pnp:WebParts>
   <pnp:WebPart />
</pnp:WebParts>

Here follow the available child elements for the element.

Element Type Description
WebPart WebPartPageWebPart

Page

Defines a Page element, to describe a page that will be provisioned into the target Site. Because of the Layout attribute, the assumption is made that you're referring/creating a WikiPage.

<pnp:Page
      Url="xsd:string"
      Overwrite="xsd:boolean"
      Layout="pnp:WikiPageLayout"
      WelcomePage="xsd:boolean">
   <pnp:WebParts />
</pnp:Page>

Here follow the available child elements for the Page element.

Element Type Description
WebParts WebParts The webparts to add to the page, optional collection of elements

Here follow the available attributes for the Page element.

Attibute Type Description
Url xsd:string Required: The server relative url of the page, supports tokens
Overwrite xsd:boolean Optional: if set, overwrites an existing page in the case of a wikipage.
Layout WikiPageLayout Required: Defines the layout of the wikipage
WelcomePage xsd:boolean Defines whether the page should be set as Welcomepage of the web rootfolder

WebParts

The webparts to add to the page, optional collection of elements

<pnp:WebParts>
   <pnp:WebPart />
</pnp:WebParts>

Here follow the available child elements for the element.

Element Type Description
WebPart WikiPageWebPart

WikiPageWebPart

Defines a WebPart to be added to a WikiPage

<pnp:WikiPageWebPart
      Title="xsd:string"
      Row="xsd:int"
      Column="xsd:int">
   <pnp:Contents />
</pnp:WikiPageWebPart>

Here follow the available child elements for the WikiPageWebPart element.

Element Type Description
Contents xsd:string Required: Defines the WebPart XML

Here follow the available attributes for the WikiPageWebPart element.

Attibute Type Description
Title xsd:string Required: Defines the title of the WebPart
Row xsd:int Required: Defines the row to add the WebPart to
Column xsd:int Required: Defines the column to add the WebPart to

WebPartPageWebPart

Defines a webpart to be added to a WebPart Page

<pnp:WebPartPageWebPart
      Title="xsd:string"
      Zone="xsd:string"
      Order="xsd:int">
   <pnp:Contents />
</pnp:WebPartPageWebPart>

Here follow the available child elements for the WebPartPageWebPart element.

Element Type Description
Contents xsd:string Required: Defines the WebPart XML

Here follow the available attributes for the WebPartPageWebPart element.

Attibute Type Description
Title xsd:string Required: Defines the title of the WebPart
Zone xsd:string Required: defines the zone of a WebPart Page to add the webpart to
Order xsd:int Required: defines the index of the WebPart in the zone

ComposedLook

Defines a ComposedLook element

<pnp:ComposedLook
      Name="xsd:string"
      ColorFile="xsd:string"
      FontFile="xsd:string"
      BackgroundFile="xsd:string"
      MasterPage="xsd:string"
      SiteLogo="xsd:string"
      AlternateCSS="xsd:string"
      Version="xsd:int">
</pnp:ComposedLook>

Here follow the available attributes for the ComposedLook element.

Attibute Type Description
Name xsd:string The Name of the ComposedLook, required attribute
ColorFile xsd:string The ColorFile of the ComposedLook, required attribute
FontFile xsd:string The FontFile of the ComposedLook, required attribute
BackgroundFile xsd:string The BackgroundFile of the ComposedLook, optional attribute
MasterPage xsd:string The MasterPage of the ComposedLook, required attribute
SiteLogo xsd:string The SiteLogo of the ComposedLook, optional attribute
AlternateCSS xsd:string The AlternateCSS of the ComposedLook, optional attribute
Version xsd:int The Version of the ComposedLook, optional attribute

Provider

Defines an Extensibility Provider

<pnp:Provider
      Enabled="xsd:boolean"
      HandlerType="xsd:string">
   <pnp:Configuration />
</pnp:Provider>

Here follow the available child elements for the Provider element.

Element Type Description
Configuration Configuration Defines an optional configuration section for the Extensibility Provider. The configuration section can be any XML

Here follow the available attributes for the Provider element.

Attibute Type Description
Enabled xsd:boolean Defines whether the Extensibility Provider is enabled or not, optional attribute
HandlerType xsd:string The type of the handler. It can be a FQN of a .NET type, the URL of a node.js file, or whatever else, required attribute

Configuration

Defines an optional configuration section for the Extensibility Provider. The configuration section can be any XML

<pnp:Configuration>
   <!-- Any other XML content -->
</pnp:Configuration>

ProvisioningTemplateFile

An element that references an external file.

<pnp:ProvisioningTemplateFile
      File="xsd:string"
      ID="xsd:ID">
</pnp:ProvisioningTemplateFile>

Here follow the available attributes for the ProvisioningTemplateFile element.

Attibute Type Description
File xsd:string Absolute or relative path to the file.
ID xsd:ID ID of the referenced template

ProvisioningTemplateReference

An element that references an external file.

<pnp:ProvisioningTemplateReference
      ID="xsd:IDREF">
</pnp:ProvisioningTemplateReference>

Here follow the available attributes for the ProvisioningTemplateReference element.

Attibute Type Description
ID xsd:IDREF ID of the referenced template

Sequence

Each Provisioning file is split into a set of Sequence elements. The Sequence element groups the artefacts to be provisioned into groups. The Sequences must be evaluated by the provisioning engine in the order in which they appear.

<pnp:Sequence
      SequenceType=""
      ID="xsd:ID">
   <pnp:SiteCollection />
   <pnp:Site />
   <pnp:TermStore />
   <pnp:Extensions />
</pnp:Sequence>

Here follow the available child elements for the Sequence element.

Element Type Description
SiteCollection SiteCollection
Site Site
TermStore TermStore
Extensions Extensions

Here follow the available attributes for the Sequence element.

Attibute Type Description
SequenceType Instructions to the Provisioning engine on how the Containers within the Sequence can be provisioned.
ID xsd:ID A unique identifier of the Sequence

SiteCollection

Defines a SiteCollection that will be created into the target tenant/farm

<pnp:SiteCollection
      Url="pnp:ReplaceableString">
   <pnp:Templates />
</pnp:SiteCollection>

Here follow the available child elements for the SiteCollection element.

Element Type Description
Templates Templates

Here follow the available attributes for the SiteCollection element.

Attibute Type Description
Url ReplaceableString Absolute Url to the site

Site

Defines a Site that will be created into a target Site Collection

<pnp:Site
      UseSamePermissionsAsParentSite="xsd:boolean"
      Url="pnp:ReplaceableString">
   <pnp:Templates />
</pnp:Site>

Here follow the available child elements for the Site element.

Element Type Description
Templates Templates

Here follow the available attributes for the Site element.

Attibute Type Description
UseSamePermissionsAsParentSite xsd:boolean
Url ReplaceableString Relative Url to the site

TermStore

A TermStore to use for provisioning of TermGroups

<pnp:TermStore
      Scope="">
   <pnp:TermGroup />
</pnp:TermStore>

Here follow the available child elements for the TermStore element.

Element Type Description
TermGroup TermGroup The TermGroup element to provision into the target TermStore through, optional element

Here follow the available attributes for the TermStore element.

Attibute Type Description
Scope The scope of the term store.

TermGroup

A TermGroup to use for provisioning of TermSets and Terms

<pnp:TermGroup
      Description="xsd:string"
      Name="xsd:string"
      ID="pnp:GUID">
</pnp:TermGroup>

Here follow the available attributes for the TermGroup element.

Attibute Type Description
Description xsd:string
Name xsd:string
ID GUID

TermSetItem

Base type for TermSets and Terms

<pnp:TermSetItem
      Owner="xsd:string"
      Description="xsd:string"
      IsAvailableForTagging="xsd:boolean">
</pnp:TermSetItem>

Here follow the available attributes for the TermSetItem element.

Attibute Type Description
Owner xsd:string
Description xsd:string
IsAvailableForTagging xsd:boolean

TermSet

A TermSet to provision

<pnp:TermSet
      Language="xsd:int"
      IsOpenForTermCreation="xsd:boolean">
</pnp:TermSet>

Here follow the available attributes for the TermSet element.

Attibute Type Description
Language xsd:int
IsOpenForTermCreation xsd:boolean

Term

A Term to provision into a TermSet or a hyerarchical Term

<pnp:Term
      Language="xsd:int"
      CustomSortOrder="xsd:int">
</pnp:Term>

Here follow the available attributes for the Term element.

Attibute Type Description
Language xsd:int
CustomSortOrder xsd:int

TaxonomyItemProperties

A collection of Term Properties

<pnp:TaxonomyItemProperties>
   <pnp:Property />
</pnp:TaxonomyItemProperties>

Here follow the available child elements for the TaxonomyItemProperties element.

Element Type Description
Property StringDictionaryItem

TermLabels

A collection of Term Labels, in order to support multi-language terms

<pnp:TermLabels>
   <pnp:Label />
</pnp:TermLabels>

Here follow the available child elements for the TermLabels element.

Element Type Description
Label Label

Label

<pnp:Label
      Language="xsd:int"
      Value="xsd:string"
      IsDefaultForLanguage="xsd:boolean">
</pnp:Label>

Here follow the available attributes for the element.

Attibute Type Description
Language xsd:int
Value xsd:string
IsDefaultForLanguage xsd:boolean

TermSets

A collection of TermSets to provision

<pnp:TermSets>
   <pnp:TermSet />
</pnp:TermSets>

Here follow the available child elements for the TermSets element.

Element Type Description
TermSet TermSet

Extensions

Extensions are custom XML elements and instructions that can be extensions of this default schema or vendor or engine specific extensions.

<pnp:Extensions>
   <!-- Any other XML content -->
</pnp:Extensions>

ImportSequence

Imports sequences from an external file. All current properties should be sent to that file.

<pnp:ImportSequence
      File="xsd:string">
</pnp:ImportSequence>

Here follow the available attributes for the ImportSequence element.

Attibute Type Description
File xsd:string Absolute or relative path to the file.