Provisioning Site Collections, Portal Style

Have you ever needed to create a site collection that consists of more than one site? This is a very common scenario, and in fact this very site is an example. This site collection started as a blank site and a sub site was added using the blog site template. MOSS can create a site collection using the Collaboration or Publishing site templates and in both cases, sub sites are involved.

This is accomplished using a Provisioning Provider. The examples in this article apply to MOSS, but if you are using WSS I will talk about how to extend WSS at the bottom.

As in all examples of custom site templates that don’t involve the save as site template, *.stp, sort of site templates, this one starts with a web template file in the 12 hive’s TEMPLATE1033XML (or not 1033 if you are a different locale). For this example I have created an xml file called WEBTEMPProvisioningExample.xml that contains the following:

<?xml
version="1.0"
encoding="utf-8"?>

<!– _lcid="1033" _version="12.0.4518" _dal="1" –>

<!– _LocalBinding –>

<Templates
xmlns:ows="Microsoft SharePoint">

<Template
Name="TeamSiteWithBlog"
ID="9172004">

<Configuration
ID="0"

            Title="Team Site with Blog Sample"

            Hidden="FALSE"

            ImageUrl="/_layouts/images/stsprev.png"

            Description="Team site with blog provisioning example."

            DisplayCategory="eLumenotion"

            AllowGlobalFeatureAssociations="True"

            ProvisionAssembly="Microsoft.SharePoint.Publishing, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c"

        ProvisionClass="Microsoft.SharePoint.Publishing.PortalProvisioningProvider"

            ProvisionData="SiteTemplates\eLumenotion\xml\Provisioning.xml"

    />

</Template>

</Templates>

This file says that we have a new site definition that will display in the eLumenotion group called ‘Team Site with Blog Sample’. It points to a second file, Provisioning.xml that is located in the 12 hive’s TEMPLATESiteTemplateseLumenotionXML folder that contains the following:

<?xml
version="1.0"
encoding="utf-8"?>

<portal
xmlns="PortalTemplate.xsd">

<web
name="Team Site with Blog"

         siteDefinition="STS#0"

         displayName="Team Site with Blog"

         description="A root level team site with a blog." >

<webs>

<web
name="Demo Blog"


siteDefinition="BLOG#0"


displayName="A Blog"


description="A site for a person or team to post ideas, observations, and expertise that site visitors can comment on." />

</webs>

</web>

</portal>

The result is that when a user chooses to create a new site collection, MOSS invokes the Microsoft.SharePoint.Publishing.PortalProvisioningProvider class to read in the file specified by the ProvisioningData attribute and create the Sites and webs. And the result is a team site with a blog as a sub site.

It’s unfortunate that this handy little class, PortalProvisioningProvider, is in an assembly that doesn’t come with WSS, but it is pretty simple, and the provider model makes creating your own close to trivial.

All you need is a class based on SPWebProvisioningProvider. This abstract class defines a single method that accepts a SPWebProvisioningProperties that contains the SPWeb at the root of the new site collection and a string that has the path to the file containing the rest of the provisioning instructions that contains anything you want!

So, what could you do with an implementation of SPWebProvisioningProvider? Well, right off the top of my head you could:

Create a collection of subsites.

Configure any arbitrary aspect of the site through code.

Add and activate features.

Deactivate features.

Create site columns, content types, and lists.


You get the idea. Basically anything that you could do through the object model is possible. This is the equivalent of a feature receiver for a site template.

I personally don’t think you should use this as an alternative to schema xml, because no one can peer into your dll short of reflector or its equivalent, but if you wanted to create a third party solution that was obfuscated or if you just can’t figure out the xml definitions and have to show something tomorrow or be fired, it might not be the worst thing in the world.