Topic automatically generated on 9/20/2015
##Namespace The namespace of the PnP Provisioning Schema is:
http://schemas.dev.office.com/PnP/2015/08/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.
<pnp:Provisioning
xmlns:pnp="http://schemas.dev.office.com/PnP/2015/08/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/08/ProvisioningSchema"
ID="xsd:ID"
Version="xsd:decimal"
ImagePreviewUrl="xsd:string"
DisplayName="xsd:string"
Description="xsd:string">
<pnp:Properties />
<pnp:SitePolicy />
<pnp:RegionalSettings />
<pnp:SupportedUILanguages />
<pnp:AuditSettings />
<pnp:PropertyBagEntries />
<pnp:Security />
<pnp:SiteFields />
<pnp:ContentTypes />
<pnp:Lists />
<pnp:Features />
<pnp:CustomActions />
<pnp:Files />
<pnp:Pages />
<pnp:TermGroups />
<pnp:ComposedLook />
<pnp:Workflows />
<pnp:SearchSettings />
<pnp:Publishing />
<pnp:AddIns />
<pnp:Providers />
</pnp:ProvisioningTemplate>
Here follow the available child elements for the ProvisioningTemplate element.
Element | Type | Description |
---|---|---|
Properties | ProvisioningTemplateProperties | A set of custom Properties for the Provisioning Template, optional element. |
SitePolicy | ReplaceableString | The Site Policy of the Provisioning Template, optional element. |
RegionalSettings | RegionalSettings | The Regional Settings of the Provisioning Template, optional element. |
SupportedUILanguages | SupportedUILanguages | The Supported UI Languages for the Provisioning Template, optional element. |
AuditSettings | AuditSettings | The Audit Settings for the Provisioning Template, optional element. |
PropertyBagEntries | PropertyBagEntries | The Property Bag entries of the Provisioning Template, optional collection of elements. |
Security | Security | The Security configurations 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. |
Workflows | Workflows | The Workflows for the Provisioning Template, optional element. |
SearchSettings | SearchSettings | The Search Settings for the Provisioning Template, optional element. |
Publishing | Publishing | The Publishing capabilities configuration for the Provisioning Template, optional element. |
AddIns | AddIns | The SharePoint Add-ins to provision into the target Site through 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, optional attribute. |
ImagePreviewUrl | xsd:string | The Image Preview Url of the Provisioning Template, optional attribute. |
DisplayName | xsd:string | The Display Name of the Provisioning Template, optional attribute. |
Description | xsd:string | The Description of the Provisioning Template, optional 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.
<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. |
###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 | |
###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 | |
###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. |
###SearchSettings | ||
The Search Settings for the Provisioning Template, optional element. |
<pnp:SearchSettings>
<!-- Any other XML content -->
</pnp:SearchSettings>
###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 | |
###ProvisioningTemplateProperties | ||
A set of custom Properties for the Provisioning Template. |
<pnp:ProvisioningTemplateProperties>
<pnp:Property />
</pnp:ProvisioningTemplateProperties>
Here follow the available child elements for the ProvisioningTemplateProperties element.
Element | Type | Description |
---|---|---|
Property | StringDictionaryItem | A custom Property for the Provisioning Template, collection of elements. |
###RegionalSettings | ||
Defines the Regional Settings for a site. |
<pnp:RegionalSettings
AdjustHijriDays="xsd:int"
AlternateCalendarType="pnp:CalendarType"
CalendarType="pnp:CalendarType"
Collation="xsd:int"
FirstDayOfWeek="pnp:DayOfWeek"
FirstWeekOfYear="xsd:int"
LocaleId="xsd:int"
ShowWeeks="xsd:boolean"
Time24="xsd:boolean"
TimeZone="pnp:ReplaceableInt"
WorkDayEndHour="pnp:WorkHour"
WorkDays="xsd:int"
WorkDayStartHour="pnp:WorkHour">
</pnp:RegionalSettings>
Here follow the available attributes for the RegionalSettings element.
<pnp:SupportedUILanguages>
<pnp:SupportedUILanguage />
</pnp:SupportedUILanguages>
Here follow the available child elements for the SupportedUILanguages element.
Element | Type | Description |
---|---|---|
SupportedUILanguage | SupportedUILanguage | Defines a single Supported UI Language for a site. |
###SupportedUILanguage | ||
Defines a single Supported UI Language for a site. |
<pnp:SupportedUILanguage
LCID="xsd:int">
</pnp:SupportedUILanguage>
Here follow the available attributes for the element.
<pnp:AuditSettings
AuditLogTrimmingRetention="xsd:int"
TrimAuditLog="xsd:boolean">
<pnp:Audit />
</pnp:AuditSettings>
Here follow the available child elements for the AuditSettings element.
Element | Type | Description |
---|---|---|
Audit | Audit | A single Audit setting defined by an AuditFlag. |
Here follow the available attributes for the AuditSettings element.
<pnp:Audit
AuditFlag="">
</pnp:Audit>
Here follow the available attributes for the element.
<pnp:PropertyBagEntries>
<pnp:PropertyBagEntry />
</pnp:PropertyBagEntries>
Here follow the available child elements for the PropertyBagEntries element.
Element | Type | Description |
---|---|---|
PropertyBagEntry | PropertyBagEntry | |
###Security | ||
The Security configurations of the Provisioning Template, optional collection of elements. |
<pnp:Security>
<pnp:AdditionalAdministrators />
<pnp:AdditionalOwners />
<pnp:AdditionalMembers />
<pnp:AdditionalVisitors />
<pnp:SiteGroups />
<pnp:Permissions />
</pnp:Security>
Here follow the available child elements for the Security 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. |
SiteGroups | SiteGroups | List of additional Groups for the Site, optional collection of elements. |
Permissions | Permissions | |
###Permissions |
<pnp:Permissions>
<pnp:RoleDefinitions />
<pnp:RoleAssignments />
</pnp:Permissions>
Here follow the available child elements for the element.
Element | Type | Description |
---|---|---|
RoleDefinitions | RoleDefinitions | List of Role Definitions for the Site, optional collection of elements. |
RoleAssignments | RoleAssignments | List of Role Assignments for the Site, optional collection of elements. |
###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 Features 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 CustomActions element.
Element | Type | Description |
---|---|---|
SiteCustomActions | CustomActionsList | The Site Custom Actions to provision while applying the Provisioning Template, optional collection of elements. |
WebCustomActions | CustomActionsList | The Web Custom Actions to provision while applying the Provisioning Template, optional collection of elements. |
###Pages | ||
The Pages to provision into the target Site through the Provisioning Template, optional collection of elements. |
<pnp:Pages
WelcomePage="xsd:string">
<pnp:Page />
</pnp:Pages>
Here follow the available child elements for the Pages element.
Element | Type | Description |
---|---|---|
Page | Page |
Here follow the available attributes for the Pages element.
<pnp:PropertyBagEntry
Overwrite="xsd:boolean"
Indexed="xsd:boolean">
</pnp:PropertyBagEntry>
Here follow the available attributes for the PropertyBagEntry element.
<pnp:StringDictionaryItem
Key="xsd:string"
Value="xsd:string">
</pnp:StringDictionaryItem>
Here follow the available attributes for the StringDictionaryItem element.
<pnp:UsersList>
<pnp:User />
</pnp:UsersList>
Here follow the available child elements for the UsersList element.
Element | Type | Description |
---|---|---|
User | User | |
###User | ||
The base 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. |
###SiteGroups | ||
List of Site Groups for the Site Security, collection of elements. |
<pnp:SiteGroups>
<pnp:SiteGroup />
</pnp:SiteGroups>
Here follow the available child elements for the SiteGroups element.
Element | Type | Description |
---|---|---|
SiteGroup | SiteGroup | |
###SiteGroup | ||
The base type for a Site Group element. |
<pnp:SiteGroup
Title="xsd:string"
Description="xsd:string"
Owner="xsd:string"
AllowMembersEditMembership="xsd:boolean"
AllowRequestToJoinLeave="xsd:boolean"
AutoAcceptRequestToJoinLeave="xsd:boolean"
OnlyAllowMembersViewMembership="xsd:boolean"
RequestToJoinLeaveEmailSetting="xsd:string">
<pnp:Members />
</pnp:SiteGroup>
Here follow the available child elements for the SiteGroup element.
Element | Type | Description |
---|---|---|
Members | UsersList | The list of members of the Site Group, optional element. |
Here follow the available attributes for the SiteGroup element.
<pnp:RoleDefinitions>
<pnp:RoleDefinition />
</pnp:RoleDefinitions>
Here follow the available child elements for the RoleDefinitions element.
Element | Type | Description |
---|---|---|
RoleDefinition | RoleDefinition | |
###RoleDefinition |
<pnp:RoleDefinition
Name="xsd:string"
Description="xsd:string">
<pnp:Permissions />
</pnp:RoleDefinition>
Here follow the available child elements for the RoleDefinition element.
Element | Type | Description |
---|---|---|
Permissions | Permissions | Defines the Permissions of the Role Definition, required element. |
Here follow the available attributes for the RoleDefinition element.
<pnp:Permissions>
<pnp:Permission />
</pnp:Permissions>
Here follow the available child elements for the element.
Element | Type | Description |
---|---|---|
Permission | Permission | Defines a Permission for a Role Definition. |
###RoleAssignments | ||
List of Role Assignments for a target Principal, collection of elements. |
<pnp:RoleAssignments>
<pnp:RoleAssignment />
</pnp:RoleAssignments>
Here follow the available child elements for the RoleAssignments element.
Element | Type | Description |
---|---|---|
RoleAssignment | RoleAssignment | |
###RoleAssignment |
<pnp:RoleAssignment
Principal="xsd:string"
RoleDefinition="xsd:string">
</pnp:RoleAssignment>
Here follow the available attributes for the RoleAssignment element.
<pnp:ObjectSecurity>
<pnp:BreakRoleInheritance />
</pnp:ObjectSecurity>
Here follow the available child elements for the ObjectSecurity element.
Element | Type | Description |
---|---|---|
BreakRoleInheritance | BreakRoleInheritance | |
###BreakRoleInheritance | ||
Declares a section of custom permissions, breaking role inheritance from parent. |
<pnp:BreakRoleInheritance
CopyRoleAssignments="xsd:boolean"
ClearSubscopes="xsd:boolean">
<pnp:RoleAssignment />
</pnp:BreakRoleInheritance>
Here follow the available child elements for the element.
Element | Type | Description |
---|---|---|
RoleAssignment | RoleAssignment |
Here follow the available attributes for the 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:FieldDefaults />
<pnp:Security />
</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 | Defines a collection of rows that will be added to the List Instance, optional element. |
FieldDefaults | FieldDefaults | Defines a list of default values for the Fields of the List Instance, optional collection of elements. |
Security | ObjectSecurity | Defines the Security rules for the List Instance, optional element. |
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.
<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 | ||
Defines a collection of rows that will be added to the List Instance, optional element. |
<pnp:DataRows>
<pnp:DataRow />
</pnp:DataRows>
Here follow the available child elements for the element.
Element | Type | Description |
---|---|---|
DataRow | DataRow | |
###FieldDefaults | ||
Defines a list of default values for the Fields of the List Instance, optional collection of elements. |
<pnp:FieldDefaults>
<pnp:FieldDefault />
</pnp:FieldDefaults>
Here follow the available child elements for the element.
Element | Type | Description |
---|---|---|
FieldDefault | FieldDefault | Defines a default value for a Field of the List Instance. |
###DataValue | ||
The DataValue of a single field of a row to insert into a target ListInstance. |
<pnp:DataValue>
</pnp:DataValue>
###FieldDefault The FieldDefault of a single field of list or library for target ListInstance.
<pnp:FieldDefault>
</pnp:FieldDefault>
###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"
NewFormUrl="xsd:string"
EditFormUrl="xsd:string"
DisplayFormUrl="xsd:string">
<pnp:FieldRefs />
<pnp:DocumentTemplate />
<pnp:DocumentSetTemplate />
</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. |
DocumentSetTemplate | DocumentSetTemplate | Specifies the properties of the DocumentSet Template if the ContentType defines a DocumentSet. |
Here follow the available attributes for the ContentType element.
<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.
<pnp:DocumentSetTemplate
WelcomePage="xsd:string">
<pnp:AllowedContentTypes />
<pnp:DefaultDocuments />
<pnp:SharedFields />
<pnp:WelcomePageFields />
</pnp:DocumentSetTemplate>
Here follow the available child elements for the DocumentSetTemplate element.
Element | Type | Description |
---|---|---|
AllowedContentTypes | AllowedContentTypes | |
DefaultDocuments | DefaultDocuments | |
SharedFields | SharedFields | |
WelcomePageFields | WelcomePageFields |
Here follow the available attributes for the DocumentSetTemplate element.
<pnp:AllowedContentTypes>
<pnp:AllowedContentType />
</pnp:AllowedContentTypes>
Here follow the available child elements for the element.
Element | Type | Description |
---|---|---|
AllowedContentType | AllowedContentType | |
###DefaultDocuments | ||
The list of default Documents for the Document Set, optional element. |
<pnp:DefaultDocuments>
<pnp:DefaultDocument />
</pnp:DefaultDocuments>
Here follow the available child elements for the element.
Element | Type | Description |
---|---|---|
DefaultDocument | DefaultDocument | |
###SharedFields | ||
The list of Shared Fields for the Document Set, optional element. |
<pnp:SharedFields>
<pnp:SharedField />
</pnp:SharedFields>
Here follow the available child elements for the element.
Element | Type | Description |
---|---|---|
SharedField | DocumentSetFieldRef | |
###WelcomePageFields | ||
The list of Welcome Page Fields for the Document Set, optional element. |
<pnp:WelcomePageFields>
<pnp:WelcomePageField />
</pnp:WelcomePageFields>
Here follow the available child elements for the element.
Element | Type | Description |
---|---|---|
WelcomePageField | DocumentSetFieldRef | |
###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.
<pnp:FieldRefBase
ID="pnp:GUID">
</pnp:FieldRefBase>
Here follow the available attributes for the FieldRefBase element.
Attibute | Type | Description |
---|---|---|
ID | GUID | The value of the field ID to bind, required attribute. |
###FieldRefFull |
<pnp:FieldRefFull>
</pnp:FieldRefFull>
###ListInstanceFieldRef Defines the binding between a ListInstance and a Field.
<pnp:ListInstanceFieldRef
DisplayName="xsd:string">
</pnp:ListInstanceFieldRef>
Here follow the available attributes for the ListInstanceFieldRef element.
<pnp:ContentTypeFieldRef>
</pnp:ContentTypeFieldRef>
###DocumentSetFieldRef Defines the binding between a Document Set and a Field.
<pnp:DocumentSetFieldRef>
</pnp:DocumentSetFieldRef>
###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.
<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:Security />
</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. |
Security | ObjectSecurity |
Here follow the available attributes for the File element.
<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">
<pnp:WebParts />
<pnp:Security />
</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. |
Security | ObjectSecurity |
Here follow the available attributes for the Page element.
<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 | Defines the WebPart XML, required element. |
Here follow the available attributes for the WikiPageWebPart element.
<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 | Defines the WebPart XML, required element. |
Here follow the available attributes for the WebPartPageWebPart 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.
<pnp:Workflows>
<pnp:WorkflowDefinitions />
<pnp:WorkflowSubscriptions />
</pnp:Workflows>
Here follow the available child elements for the Workflows element.
Element | Type | Description |
---|---|---|
WorkflowDefinitions | WorkflowDefinitions | |
WorkflowSubscriptions | WorkflowSubscriptions | |
###WorkflowDefinitions | ||
Defines the Workflows Definitions to provision. |
<pnp:WorkflowDefinitions>
<pnp:WorkflowDefinition />
</pnp:WorkflowDefinitions>
Here follow the available child elements for the element.
Element | Type | Description |
---|---|---|
WorkflowDefinition | WorkflowDefinition | |
###WorkflowSubscriptions | ||
Defines the Workflows Subscriptions to provision. |
<pnp:WorkflowSubscriptions>
<pnp:WorkflowSubscription />
</pnp:WorkflowSubscriptions>
Here follow the available child elements for the element.
Element | Type | Description |
---|---|---|
WorkflowSubscription | WorkflowSubscription | |
###AddIns | ||
Defines the SharePoint Add-ins to provision, collection of elements. |
<pnp:AddIns>
<pnp:Addin />
</pnp:AddIns>
Here follow the available child elements for the AddIns element.
Element | Type | Description |
---|---|---|
Addin | Addin | |
###Addin |
<pnp:Addin
PackagePath="xsd:string"
Source="">
</pnp:Addin>
Here follow the available attributes for the element.
<pnp:Publishing
AutoCheckRequirements="">
<pnp:DesignPackage />
<pnp:AvailableWebTemplates />
<pnp:PageLayouts />
</pnp:Publishing>
Here follow the available child elements for the Publishing element.
Element | Type | Description |
---|---|---|
DesignPackage | DesignPackage | Defines a Design Package to import into the current Publishing site, optional element. |
AvailableWebTemplates | AvailableWebTemplates | Defines the Available Web Templates for the current Publishing site, optional collection of elements. |
PageLayouts | PageLayouts | Defines the Available Page Layouts for the current Publishing site, optional collection of elements. |
Here follow the available attributes for the Publishing element.
<pnp:DesignPackage
DesignPackagePath="xsd:string"
MajorVersion="xsd:int"
MinorVersion="xsd:int"
PackageGuid="pnp:GUID"
PackageName="xsd:string">
</pnp:DesignPackage>
Here follow the available attributes for the element.
<pnp:AvailableWebTemplates>
<pnp:WebTemplate />
</pnp:AvailableWebTemplates>
Here follow the available child elements for the element.
Element | Type | Description |
---|---|---|
WebTemplate | WebTemplate | Defines an available Web Template for the current Publishing site. |
###PageLayouts | ||
Defines the Available Page Layouts for the current Publishing site, optional collection of elements. |
<pnp:PageLayouts
Default="xsd:string">
<pnp:PageLayout />
</pnp:PageLayouts>
Here follow the available child elements for the element.
Element | Type | Description |
---|---|---|
PageLayout | PageLayout | Defines an available Page Layout for the current Publishing site. |
Here follow the available attributes for the element.
Attibute | Type | Description |
---|---|---|
Default | xsd:string | Defines the URL of the Default Page Layout for the current Publishing site, if any. 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.
<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.
<pnp:ProvisioningTemplateReference
ID="xsd:IDREF">
</pnp:ProvisioningTemplateReference>
Here follow the available attributes for the ProvisioningTemplateReference element.
<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 | A Site Collection to provision through a Sequence, optional element. |
Site | Site | A Site to provision through a Sequence, optional element. |
TermStore | TermStore | A Term Store to provision through a Sequence, optional element. |
Extensions | Extensions | Any Extension to provision through a Sequence, optional element. |
Here follow the available attributes for the Sequence element.
<pnp:SiteCollection
Url="pnp:ReplaceableString">
<pnp:Templates />
</pnp:SiteCollection>
Here follow the available child elements for the SiteCollection element.
Element | Type | Description |
---|---|---|
Templates | Templates | Templates that can be provisioned together with the Site Collection, optional collection of elements. |
Here follow the available attributes for the SiteCollection element.
Attibute | Type | Description |
---|---|---|
Url | ReplaceableString | Absolute Url to the site, required attribute. |
###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 | Templates that can be provisioned together with the Site, optional collection of elements. |
Here follow the available attributes for the Site element.
<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 collection of elements. |
Here follow the available attributes for the TermStore element.
Attibute | Type | Description |
---|---|---|
Scope | The scope of the term store, required attribute. | |
###TermGroup | ||
A TermGroup to use for provisioning of TermSets and Terms. |
<pnp:TermGroup
Description="xsd:string"
SiteCollectionTermGroup="xsd:boolean"
Name="xsd:string"
ID="pnp:GUID">
</pnp:TermGroup>
Here follow the available attributes for the TermGroup element.
<pnp:TermSetItem
Owner="xsd:string"
Description="xsd:string"
IsAvailableForTagging="xsd:boolean">
</pnp:TermSetItem>
Here follow the available attributes for the TermSetItem element.
<pnp:TermSet
Language="xsd:int"
IsOpenForTermCreation="xsd:boolean">
</pnp:TermSet>
Here follow the available attributes for the TermSet element.
<pnp:Term
Language="xsd:int"
CustomSortOrder="xsd:int">
</pnp:Term>
Here follow the available attributes for the Term element.
<pnp:TaxonomyItemProperties>
<pnp:Property />
</pnp:TaxonomyItemProperties>
Here follow the available child elements for the TaxonomyItemProperties element.
Element | Type | Description |
---|---|---|
Property | StringDictionaryItem | A Term Property, collection of elements. |
###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.
<pnp:TermSets>
<pnp:TermSet />
</pnp:TermSets>
Here follow the available child elements for the TermSets element.
Element | Type | Description |
---|---|---|
TermSet | TermSet | A Term Set, optional collection of elements. |
###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, required attribute. |