The Microsoft SharePoint Server Feature and Solution Framework An Overview Michael Mukalian – Technology Manager

Page 2 Agenda Introduction of LiquidHub –LiquidHub at a Glance –About LiquidHub’s SharePoint Center of Excellence What are Features? Feature Makeup Feature.xml Feature Manifest File STSADM.EXE: Feature Installation and Activation STSADM.EXE: Feature Deactivation and Un-installation Feature Dependency Feature Stapling What is a Solution? Solution Makeup Solution Manifest File Diamond Definition File Solution Package: Creation and Deployment Solution Package: Retraction and Deletion Links of Interest

What are Features? “Features are awesome!” – Ted PattisonTed Pattison Provide the ability (feature? ) to define, modify and work with elements and objects within a Site –Site Columns, Content Types, Lists –Master Pages, Page Layouts –Web Parts –Menu Commands, CustomActions –FeatureReceivers and EventReceivers Brand new for WSS 3.0 –Made up of Features…see “12 Hive” –C:\Program Files\Common Files\Microsoft Shared\web server extensions\12 Feature Dependency –Allows the developer to create a hierarchy of dependent Features Can’t install one without the other Feature Stapling –Allows for the association (stapling) of a Feature to a Site Definition, so that as a Site Definition is chosen the Feature is “packaged” with it Page 3

Feature Makeup: feature.xml & Feature Manifest The following are the minimum files necessary to create and install a feature –feature.xml –elements.xml (Feature Manifest file) Page 4

Feature.xml Feature.xml contains the necessary information about the Feature to be installedFeature.xml – Id: GUID identifying the Feature –Title: Feature title (text) –Description: Feature description (text) –Scope: The scope in which the Feature can be activated Farm; WebApplication; Site (Site Collection); Web (Site) –Hidden: Optional (boolean) –Version: Optional; Specifies a System.Version-compliant representation of the version of a Feature (#.#.#.#) – : Node containing nodes – : Specifies a file that contains an element definition (Site Column, Content Type, Master Page, etc.) for a Feature Element Page 5

Feature Manifest File The Feature Manifest file contains the necessary information related to an element of the Feature to be installed. element A Feature can have 1-to-many Feature Manifest files (named differently) This example create a custom Site Column using the node structure – Id: GUID identifying the custom Site Column –Name: Internal Field Name of the column –DisplayName: Display Name of the column –Type: Data Type of this column (Text; Integer; Choice; etc) Page 6

STSADM.EXE: Feature Installation an Activation Step 1: Install the Feature –stsadm -o installfeature {-filename | -name }installfeature -filename: Relative to the Features folder in the 12 Hive -name: Corresponds to the name of the feature in the feature.xml file Step 2: Activate the Feature –stsadm -o activatefeature {-filename | -name | -id } [-url] activatefeature -filename: Relative to the Features folder in the 12 Hive -name: Corresponds to the name of the feature in the feature.xml file -id: Feature GUID in the feature.xml file -url: URL of the Web application, Site Collection, or Web site to which the feature is being activated –OR Site  Site Actions  Site Settings  Site (Collection) Features Page 7

STSADM.EXE: Feature Deactivation and Un-installation stsadm -o deactivatefeature {–filename | -name | -id } [-url] deactivatefeature –-filename: Relative to the Features folder in the 12 Hive –-name: Corresponds to the name of the feature in the feature.xml file –-id: Feature GUID in the feature.xml file –-url: URL of site to activate Feature stsadm -o uninstallfeature {-filename | -name | -id }uninstallfeature –-filename: Relative to the Features folder in the 12 Hive –-name: Corresponds to the name of the feature in the feature.xml file –-id: Feature GUID in the feature.xml file Page 8

Feature Dependency Feature Dependencies are Features that are dependent on other Features Used when you have a Feature that contains elements that are built on or referenced by other Features –Site Columns, Content Types, etc A “one-liner” (actually 3) is added to the Feature’s feature.xml file associating it with the Feature that it is dependent on – ActivationDependencies ActivationDependency – Page 9

Feature Stapling Feature Stapling allows you to “attach” (staple) a Feature to a Site Definition without modifying said Site Definition in anyway This allows you to add the Feature to any Sites created using that Site Definition –Ex. Corporate Intranet-type environments that require certain standard functionality to exist through all sites that will be created in the collection –Ex. Custom Web Parts you want available across sites to be created in the Site Collection Basically a Feature in-and-of-itself, that’s associated to another Feature with the relevant Site Definitions –A “one-liner” (really) added to the “elements.xml” file that contains the Site Definition Template Name and the Feature ID to associate to it –TemplateName: STS#0; STS#1; BDR#0; GLOBAL, etc. Page 10

What is a Solution A Solution is a package that’s created that bundles up all of the necessary components for extending WSS/MOSS services –It is a.CAB-based format with a.WSP extension –It is a deployable and reusable package –It is the recommended way to deploy elements as the solution store helps in the deployment to all of the web front-end servers –Best Practice when deploying code between environments Page 11

Solution Makeup The desired Feature to install A Solution Manifest File (XML format) A Diamond Definition File (.DDF) –Simple text file containing the building instructions for the MakeCAB utility Resultant Solution Package File (.WSP) –Created as the result of running MakeCAB against the.DDFMakeCAB –Tip: Rename the.WSP to.CAB and you can open up/explore the contents Page 12

Solution Manifest File The Solution Manifest File references the Feature to be packaged as part of this SolutionSolution Manifest File Assigns properties to the Solution –SolutionId: GUID –ResetWebServer: Boolean; specifies that the Web server be reset through IIS –DeploymentServerType: ApplicationServer; WebFrontEnd Page 13

Diamond Definition File The Diamond Definition File contains the set of build instructions for the MakeCAB utility Running MakeCAB with the associated.DDF file results in your SharePoint Solution Package (.WSP).CAB-based format Example –Settings DiskDirectoryTemplate=CDROM: All cabinets go in a single directory CompressionType=MSZIP: All files in the cabinet are compressed UniqueFiles=Off: Duplicate destination file names are not allowed Cabinet=On: Turns Cabinet Mode on –Files as part of the package manifest.xml –Solution Manifest Set the DestinationDirectory –Where Feature will be installed Includes the following files –feature.xml and elements.xml Page 14

Solution Package Creation and Deployment Page 15 Step 1: Create the Package (.WSP) –MAKECAB.EXE /F filename.ddf /D CabinetNameTemplate=filename.wsp /D DiskDirectory1=Package\ Create a.WSP file named filename.wsp using the filename.ddf and place it in a directory Package Step 2: Add the Solution to the Solution Store –Copy the.WSP to the BIN folder in the “12 Hive” –stsadm.exe -o addsolution –filename filename.wspaddsolution Only adds to the Solution store, no deployment Step 3: Deploy the Solution –stsadm.exe -o deploysolution -name filename.wsp –immediatedeploysolution Deploys Solution -immediate (as in right now to all servers in the Farm, timer job kicks in) –-local: just this server –-time: specific time to deploy to all servers in the Farm -force: Optional, forces deployment even if it’s deployed already

Solution Package Retraction and Deletion Page 16 Step 1: Retract the Solution –stsadm.exe -o retractsolution -name filename.wsp –immediateretractsolution Kicks off timer job to retract Solution Step 2: Delete the Solution –stsadm.exe -o deletesolution -name filename.wspdeletesolution Removes Solution from the store Step 3: Delete.WSP from BIN –Navigate to BIN folder and delete filename.wsp

Links of Interest Creating a Custom Feature in Office SharePoint Server 2007 What are Features? Andrew Connell’s Web Content Management Links: Features Feature Stapling in WSS V3 Solutions Overview Microsoft Cabinet Software Development Kit Creating a SharePoint Solution Package (.wsp) in 5 steps Automation in Visual Studio 2005 for WSS v3 Feature Development How to configure Code Access Security for a Web Part –Utilizes Features/Solutions to do so Page 17

Thank You! Page 18

Page 19 LiquidHub at a Glance Overview:In business since 2001 LiquidHub, Inc. is a systems integrator and technology consultancy delivering Management Consulting, Application Integration, Data Management & Integration, and Infrastructure Solutions. Associates:500 associates worldwide Locations:Philadelphia, Hyderabad India, and Boston Industry-Focused:Life Sciences, Financial Services, Insurance, Emerging Markets Approach:Combining the planning and strategy of Enterprise Architecture and the execution of Service Oriented Architectures, our consultants work with clients to make the most of existing IT system assets while providing a flexible technology architecture that will work long-term. Our Differentiators:Local Presence with Equal or Better Quality of Services at Better Price Point than larger Consultancies. Focus of Services and Industries Immediate Access to Executive Management

About LiquidHub’s SharePoint Center of Excellence The SharePoint CoE is focused on: –Helping companies utilize the full capabilities of MOSS 2007 in the areas of administration, configuration, development, training, and support Our approach helps our clients: –Integrate MOSS with current processes –Integrate MOSS with existing Enterprise and Legacy systems –Jumpstart application development using MOSS Page 20