SharePoint Build Template
This is a SharePoint Build Template. It is designed so that you can record the content of the SharePoint installation in terms of its software, and refer to the documents that will guide the installation of SharePoint.
The Software Build Template is referred from my book, Managing and Implementing SharePoint 2010 Projects.
Generally, software build documents are not carried out simply because SharePoint is listed for installation as a list of steps to install it, not as a list of items in a product.
It is important to list the software though, since SharePoint versions are likely to change, the operating system under which it runs may have different versions; you have to install hot-fixes, patches. And, of course, there is the pre-requisite software to install.
Of course, you could build such a list yourself, but in terms of ensuring there is a standard way of providing such a SharePoint Build Template that could be linked to the organizations Configuration Management Plan, I hope you will find this helpful.
Additionally, this document is presented as a download so you can save it as a template to use in your own SharePoint deployment projects.
Note that this template includes a section called Installation Steps. This is simply a reference to the areas used to install SharePoint following a standard method.
1 Introduction ... 2
1.1 Purpose ... 2
1.2 Definitions, Acronyms and Abbreviations ... 2
1.3 Intended Audience... 3
1.4 Software Scope ... 3
1.5 References ... 3
2 Overall Description ... 4
2.1 Operating System ... 4
2.3 Prerequisites ... 4
2.4 SharePoint ... 6
2.5 Hot fixes and Patches ... 6
2.6 User Documentation ... 6
2.7 3rd Party ... 7
2.8 Assumptions and Dependencies... 7
3 Installation ... 8
1
Introduction
<Use this section to give the reader a clear idea on the contents of this document, the author, the person(s) responsible for updating and the person(s) responsible for signing off the document.
1.1
Purpose
<Identify the SharePoint requirements by referencing this document to the SharePoint Quality Document and Project Plan, including the revision or release number. Describe the scope of SharePoint that is covered by this Software Build Document - meaning, what this installation of SharePoint is going to provide>
1.2
Definitions, Acronyms and Abbreviations
<Describe any standards or typographical conventions that were followed when writing this SBP, such as fonts or highlighting that have special significance. For example, state whether certain parts of the SharePoint software inventory are assumed inherited (because a different team has already installed the relevant product). Also include any glossary terms - the key ones you must include are given below>
IIS (Internet Information Services)
A web-server, built in to Windows Server 2008 Enterprise Edition
.Net Framework
Microsoft’s next-generation code-framework technology, required to run SharePoint Foundation and SharePoint
WinWF (Windows Workflow Foundation)
Microsoft’s workflow technology, required to run SharePoint Foundation and SharePoint
SharePoint Foundation (Windows SharePoint Services)
Microsoft’s base collaboration technology, required to run SharePoint
SharePoint 2010 (SharePoint Server)
Microsoft’s enterprise collaboration technology, built on SharePoint Foundation
This is a Microsoft SharePoint Foundation / SharePoint 2010 web-site container and corresponds to a web-site within IIS
Previous versions of SharePoint referred to such items as “virtual servers”
Site Collection
This is a Microsoft SharePoint Foundation / SharePoint 2010 top-level web-site
A SharePoint site–collection is created inside a web-application
Shared Services
Shared Services roughly schemed against SP2010 2007 as follows:
Profiles, Audiences = People Service App
Search = Search Service App
Excel = Excel Service App
Performance Point = Performance Point Service App
Visio Services = Visio Service App
Word = Word Service App
PowerPoint = PowerPoint Service App
Office Web Applications = Office Web App
Project Server = Project Server App
1.3
Intended Audience
<Describe the different types of reader that the document is intended for, such as developers, project managers, marketing staff, users, testers, and documentation writers. Describe what the rest of this SBT contains and how it is organized. Suggest a sequence for reading the document, beginning with the overview sections and proceeding through the sections that are most pertinent to each reader type.>
1.4
Software Scope
<Provide a short description of the SharePoint software and components being listed and its purpose, including relevant benefits, objectives, and goals. Relate the software to corporate goals or business strategies. If a separate vision and scope document is available (and hats usually a SharePoint Quality and Project Plan), refer to it rather than duplicating its contents here.>
1.5
References
<List any other documents or Web addresses to which this SBTs. These may include user interface style guides, contracts, standards, system requirements specifications, use case documents, or a vision and scope document. Provide enough information so that the reader could access a copy of each reference, including title, author, version number, date, and source or location. Fill in the following below, modify as necessary and feel free to add your own>
[Quality Plan reference] [Project Plan reference]
[Software Specification reference]
2
Overall Description
<Use this section to describe the SharePoint environment in terms of the software used to install it>.
2.1
Operating System
<Describe the operating system being used to install SharePoint and against each server in the farm and also include the type, whether its standard or enterprise>
2.2
Related Core Software
<Summarize the related core software, for example what version of SQL Server 2008 R2 are you going to use - standard or enterprise, or are you going to use SQL Server 2005. Enter the Hotfixes and patches in the next section>
2.3
Prerequisites
<Identify the various requisite software that needs to be installed - the below are the key pre-requisites that are required to install SharePoint>
GENEVA:
http://download.microsoft.com/download/F/3/D/F3D66A7E-C974-4A60-B7A5-382A61EB7BC6/CardSpaceGeneva.amd64.msi
DOTNET3.5 - NET Framework 3.5 Service Pack 1 (Full Package)
http://download.microsoft.com/download/2/0/e/20e90413-712f-438c-988e-fdaa79a8ac3d/dotnetfx35.exe
KB959209 – Update for .NET Service Pack 1 http://go.microsoft.com/fwlink/?LinkId=136730
KB967190 – Update for .NET Service Pack 1 – File Association Issue Fix
http://www.microsoft.com/downloads/details.aspx?FamilyID=c411b91e-4dab-4550-915c-e119204d0732&displaylang=en
Microsoft Sync Framework 2.0 Redistributable Package http://www.microsoft.com/downloads/details.aspx?familyid=109DB36E-CDD0-4514-9FB5-B77D9CEA37F6&displaylang=en • BootstrapperPackage(x64).zip • DatabaseProviders-v3.0-x64-ENU.msi • ProviderServices-v2.0-x64-ENU.msi • Synchronization-v2.0-x64-ENU.msi
Microsoft Filter Pack 2.0
http://www.microsoft.com/downloads/details.aspx?FamilyId=60C92A37-719C-4077-B5C6-CAC34F4227CC&displaylang=en
Also this is located in the PREREQUISITES FOLDER in the SharePoint 2010 Installation Folder. Microsoft Chart Controls for Microsoft .NET Framework 3.5
http://www.microsoft.com/downloads/details.aspx?FamilyID=130f7986-bf49-4fe5-9ca8-910ae6ea442c&displaylang=en ADOMD.NET http://www.microsoft.com/downloads/details.aspx?FamilyID=790d631b-bff9-4f4a-b648-e9209e6ac8ad&displaylang=en • ADOMD.NET.MSI • ADOMD.Net-KB893091-v8.00.0991-x86.EXE Windows PowerShell 2.0 CTP3 http://www.microsoft.com/downloads/details.aspx?FamilyID=c913aeab-d7b4-4bb1-a958-ee6d7fe307bc&displaylang=en • PowerShell_Setup_amd64.msi ADO.NET Data Services v1.5 CTP2
http://www.microsoft.com/downloads/details.aspx?FamilyID=a71060eb-454e-4475-81a6-e9552b1034fc&displaylang=en
• ADONETDataServices_v15_CTP2.exe SQL Server Service Pack 1
http://www.microsoft.com/downloads/details.aspx?displaylang=en&FamilyID=66ab3dbb-bf3e-4f46-9559-ccc6a4f9dc19
• SQLServer2008SP1-KB968369-x64-ENU.exe
2.4
SharePoint
<Describe the nature of the SharePoint product, whether it is SharePoint Foundation, SharePoint Server 2010. Also state the version of the software, and the location of the MSIs - fill in the following table (replace the example entries, ensuring that you enter FOUNDATION, STANDARD, ENTERPRISE, INTERNET STANDARD, INTERNET ENTERPRISE against the relevant SharePoint Type>
SharePoint Type Version Location
ENTERPRISE //MYSERVERSHARE/SPS2010
2.5
Hot fixes and Patches
<Describe all of the hotfixes and patches that will be required to be installed on the SharePoint servers and any associated servers. Use the following table as a guide>
Server Hotfix / Patch Number Location
2.6
User Documentation
<List the user documentation components (such as user manuals, on-line help, and tutorials) that will be delivered along with the software. Identify any known user documentation delivery formats or standards. You could use a table here listing the user manuals by type and location, or you could simply list the relevant documentation. A good suggestion is to refer to links on Technet as necessary. A good link is below, please feel free to add more links as required.>
Hardware and Software Requirements:
http://technet.microsoft.com/en-us/library/cc262485.aspx
2.7
3rd Party
<Enter any 3rd party software related to Solutions, Features, Analytics etc - any software that will be installed to support the SharePoint platform that does not come from the creators of SharePoint (i.e. Microsoft). It is also best at this stage to enter details of where the software can be downloaded from and the location of any documentation, particularly from an online resource. This could be entered as a table of information, but I find it best to simply enter a paragraph for each product. An example of this is given below>
[The 3rd Party Product Here]
Description:[A very short paragraph on what the product does] User Documentation:[The location of the documentation]
MSI / Installation Package located at:[The location of the installation of MSI]
2.8
Assumptions and Dependencies
<List any assumed factors (as opposed to known facts) that could affect the installation of the software listed. These could include third-party or commercial components that you plan to use, issues around the development or operating environment, or constraints. The project could be affected if these assumptions are incorrect, are not shared, or change. Also identify any dependencies the project has on external factors, such as software components that you intend to reuse from another project, unless they are already documented elsewhere (for example, in the vision and scope document or the project plan).>
3
Installation
Four documents will be used to record all the steps that will need to be made after the successful installation of a SharePoint farm assumes the creation of the following items:
Service Applications
Web Applications
Site Collections
An example of the sorts of port installation steps that should be documented here include, configuring the search. This document should include any required manual configuration not documented in the deployment guide for releases of bespoke development.
1. Variables and Settings Guide
The engineer must completes this document, prior to starting the build-process [Enter Name of Document and Location Here]
2. Pre-Requisites Installation Guide
The engineer must complete this document first, as this establishes the pre-requisites on all servers that will run SharePoint 2010 in the farm, including the installation of IIS, .Net Framework and Windows Workflow [Enter Name of Document and Location Here]
3. Service Applications Installation Guide
This document establishes the installation of Service Applications like User Profile, Search and any others that need to be configured within the farm, covering basic services including Search and “My Sites”
[Enter Name of Document and Location Here]
4. Site Installation Guide
This document establishes the hosting of the Site or “Portal” This documented process is to be repeated for each Portal in the farm
[Enter Name of Document and Location Here]
5. Post Install Configuration Guide
This document will outline various post-installation tasks, which are more related to specific configuration than installation.
