implementing moss and windows share point services solutions

8/6/2019 Implementing Moss and Windows Share Point Services Solutions

http://slidepdf.com/reader/full/implementing-moss-and-windows-share-point-services-solutions 1/50

Implementing Microsoft® OfficeSharePoint® Server 2007 and Windows®SharePoint® Services 3.0 Solutions

The information contained in this document represents the current view of MicrosoftCorporation on the issues discussed as of the date of publication. Because Microsoftmust respond to changing market conditions, it should not be interpreted to be acommitment on the part of Microsoft, and Microsoft cannot guarantee the accuracy of

any information presented after the date of publication.This White Paper is for informational purposes only. MICROSOFT MAKES NOWARRANTIES, EXPRESS, IMPLIED OR STATUTORY, AS TO THE INFORMATION IN THISDOCUMENT.

Complying with all applicable copyright laws is the responsibility of the user. Withoutlimiting the rights under copyright, no part of this document may be reproduced, storedin or introduced into a retrieval system, or transmitted in any form or by any means(electronic, mechanical, photocopying, recording, or otherwise), or for any purpose,without the express written permission of Microsoft Corporation.

Microsoft may have patents, patent applications, trademarks, copyrights, or otherintellectual property rights covering subject matter in this document. Except asexpressly provided in any written license agreement from Microsoft, the furnishing of this

document does not give you any li cense to these patents, trademarks, copyrights, orother intellectual property.

Unless otherwise noted, the companies, organizations, products, domain names, e -mailaddresses, logos, people, places, and events depicted in examples herein are fictitious.No association with any real company, organization, product, domain name, e -mailaddress, logo, person, place, or event is intended or should be inferred.

© 2008 Microsoft Corporation. All rights reserved.

Microsoft, MS-DOS, Vista, Windows, Windows NT, Windows Server, ActiveX, Excel,FrontPage, InfoPath, IntelliSense, JScript, OneNote, Outlook, PivotChart, PivotTable,



Implementing Microsoft® Office SharePoint® Server 2007and Windows® SharePoint® Services 3.0 Solutions January 2008

© 2008 Microsoft Corporation. All rights reserved. By using or providing feedback on these materials, you agree to the attached license agreement.

PowerPoint, SharePoint, ShapeSheet, Visual Basic, Visual C++, Visual C#, Visual Studio,Visual Web Developer, and Visio are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.

All other trademarks are property of their respective owners.

License Agreement





Implementing Microsoft® OfficeSharePoint® Server 2007 and Windows®SharePoint® Services 3.0 Solutions

Rona LustigMicrosoft Corporation

January 2008

Applies to: Microsoft® Office SharePoint® Server 2007, Windows® SharePoint®Services 3.0

Summary : This document outlines a methodology for team SharePoint development,customization, and content authoring that aims to accelerate implementation and mitigateproduction risks. (46 printed pages)

N ote In this paper, Microsoft Office SharePoint Server (MOSS) 2007 and WindowsSharePoint Services 3.0 are collectively referred to as Microsoft SharePoint Productsand Technologies.

Executive Summary

When you begin implementing a solution based on Microsoft Office SharePoint Server (MOSS) 2007or Windows SharePoint Services on a new server, you may seek comprehensive guidelines tomanage the implementation. Concerns may include the following :

y How to manage team development for large MOSS projects?y How to deploy content and code between development and production environments?y How to prepare your develop efforts for deployment in a remote hosted environment?y How to enable developers to participate in several projects at the same time?

This document outlines a methodology for team SharePoint development, customization, andcontent authoring to help accelerate and mitigate production risks.

The document reviews implementation scenarios, tools, and the development environment. It doesnot address specific implementations (such as how to write a Web Part or how to manage workitems ); however, the document describes the requirements to achieve a successfulimplementation. In addition, it provides additional references for more research.

N ote: To keep this document¶s focus on solution implementation, we will examinedevelopment guidance for deployment in a remote hosted environment in a futuredocument .





T able of Contents

Chapter I - Document Goals ................................ ................................ ................................ ............... 5

Chapter II - Implementation Scenarios ................................ ................................ ............................... 7

Chapter III - Implementation Environments ................................ ................................ ....................... 8Chapter IV - Implementation Activities ................................ ................................ ............................ 19

Chapter V - Deployment Methods................................ ................................ ................................ .... 21

The SOLUTION Framework ................................ ................................ ................................ ........... 21

Content Deployment/Migration API ................................ ................................ ............................. 23

Chapter VI - Tools for the Job ................................ ................................ ................................ ........... 28

Chapter VII - Implementation Project Plan and Team ................................ ................................ ....... 30

Chapter VIII - Implementation Worksheet ................................ ................................ ........................ 31

Chapter IX - Hotfixes ................................ ................................ ................................ ........................ 33Chapter X - Testing ................................ ................................ ................................ .......................... 34

Chapter XI - Summary ................................ ................................ ................................ ...................... 36

Chapter XII - Glossary................................ ................................ ................................ ....................... 37

Chapter XIII - References ................................ ................................ ................................ ................. 39

Virtualization ................................ ................................ ................................ ............................... 39

SDKs and Centers ................................ ................................ ................................ ......................... 39

Dev Tools ................................ ................................ ................................ ................................ ..... 40

Packaging Tools ................................ ................................ ................................ ........................... 41

SOLUTION Framework ................................ ................................ ................................ ................. 42

Bin or Global Assembly Cache ................................ ................................ ................................ ...... 42

Features ................................ ................................ ................................ ................................ ...... 43

Authoring and customization ................................ ................................ ................................ ....... 43

Content Deployment / Migration ................................ ................................ ................................ . 43

Team Development ................................ ................................ ................................ ..................... 45

Testing, Source Control and MSF................................ ................................ ................................ .. 46

Patterns and Practices ................................ ................................ ................................ ................. 47

Chapter XIV - Credits and Thanks To ................................ ................................ ................................ 49





C hapter I - Document GoalsV ision

This document examines one way to implement a SharePoint Products and Technologies solution.

The method proposed in this document aims to achieve the following goals :

y Accelerate development.y Mitigate deployment risks.y Minimize risk to production environment.

B ackground

In this document, we use the following terms and definitions :

y SharePoint Products and Technologies: Refers to both Microsoft Office SharePoint Server

2007 and Windows SharePoint Services 3.0. y Imp lem ented solutions: Describes develo pm ent , custo m ization, and content authoring .y SOLUTIONS (in uppercase letters) 1 : Refers to the SharePoint Solutions Framework. When

used with regular roman casing, the term refers to solutions generally (such as solution to aproblem or a Microsoft® Visual Studio® solution ).

y D evelo pm ent : Refers to the following : y Featuresy SOLUTIONSy Custom fieldsy Event handlersy Custom controlsy Web Part assembliesy Document convertersy Excel services functionsy STSADM command extensionsy Custom workflows developmenty Configuration information (such as web.config files) or application datay File system modifications such as CSS (cascading style sheets or site style sheets),

definitions, custom lists, and site templatesy C usto m ization: Refers to the following :

y Master pagesy Content typesy Custom fields

y Layout pagesy Site columnsy Site designy CSSs

y C ontent authoring: Refers to the following : y Web pages and resources used in them, such as images and style sheets

1 Credit to Robert Bogue for the casing notion





B eyond the scope of this document

This document does not address the following :

y Recycle Bin items and statey Alertsy Personal Viewsy Autocopy referencesy Search index and contentsy Workflow instances and associationsy Audit traily Change log historyy Check-in/check-out statey Security statey Workflow tasks and statey Search/Shared Services Provider (SSP) settingsy Microsoft Office InfoPath® Forms configurationy Permissions

y Cachingy Data connections





C hapter II - ImplementationScenariosImplementing a server running SharePoint Products and Technologies is a many-faceted process,depending on the purpose of your installation. Depending on the level of your implementation, youmay encounter some complexities in setup and implementation, and certain requirements for arobust implementation. Scenarios for levels of implementation include :

y Level 1o Internet facing corporate siteo Critical applications

y Level 2o Corporate portal siteo Project management

y Level 3o Team collaboration sites

Level 1 implementation scenarios usually require the most effort for getting the server up (up-time),performance, and accuracy. Level 3 scenarios are less complex.

You can engage different tools and skill sets for each level. For example, an end user can performtypical duties related to the management of a team site, such as setting security permissions oncontent within the site, creating lists, creating subsites, managing the navigation (Quick Launch andTop menu bar) of the site, and configuring the appearance (look and feel) of the site. However, aprofessional developer will need to be engaged for the Internet-facing corporate site because thistype of SharePoint site typically uses components that are customized, such as master pages andPage Layouts, specialized custom menu controls, and advertisement rotating controls. 2

Despite their complexity, even level1 implementations can benefit from SharePoint componentsthat do not require code, such as easy-to-set sites, lists, and other objects which shortendevelopment time, and make it possible for nondevelopers to engage in the implementationlifecycle.

This article focuses on level 1 implementations. Projects for level 2 or level 3 sites may also benefitfrom the concepts described here, but more often do not require this restricted way of implementation.

2 Thanks to Todd Baginski!



I m

¡ ¢ m ¢ £ ¤ ¥ £ ¦ M¥ c § ¨ s ¨ © ¤ © © ¥ c ¢ § ¢ ¨ ¥ £ ¤ ¢ § ¢ § 2007£ ¥ £ ¨ s § ¢ ¨ ¥ £ ¤ ¢ § ¥ c ¢ s 3 0 ¨ ¡ ! ¤ ¥ ¨ £ s " £ ! § # 2008

© 2008 Mic $ % s %

&

'

Corporation. All right s rese rve ( . Pag e 9 By using or pro viding f ee dba c ) on th ese mat erial s 0 you agr ee to th e atta ch ed license agr ee ment.

Environ me nt 1: Lo c 1 2 , Stand-Alon e Dev elop me nt

You b egin a compon ent s deve lopm ent b y impl em enting empt y int e rfa ces with a minimum of re 3 uir ed logi c. Such a compon ent i s ref erred to a s a st ub (also known a s a mo ck ob ject ). A stubshould enabl e reporting of it s prop erti es 4 and conditionall y produ ce log eve nt s whil e running.

Stub s ar e stor ed with th e ir compl e te count erpart s for th e entir e duration of th e compon entlif ecyc le 4 and ma y be use d in oth er environm ent s for troubl es hooting ( e limination) pro cesses .Fore 5 ampl e 4 you ma y ha ve a poorl y performing

6

eb Part Pag e in a pilot environm ent.6

ith no sour ce cod e 4 you might n ee d to tak e m emor y dump s to d e tec t th e malfun ctioning compon ent. But b ecau se you ha ve th e stub s for your compon ent s 4 you can r epla ce real fun ctionalit y with it s stub

count erpart, and easily de tec t a malfun ctioning compon ent that i s invok ed som ewh ere in th e pag e .You do cum ent a stub in th e sam e wa y as an y oth er compl e te compon ent. Int egration with oth ercompon ent s is po ssible in thi s environm ent onl y b y using stub s.

The deve lopm ent environm ent i s a single-ma chin e deplo ym ent. For in stru ction s on how to se t upthi s environm ent, see Setting Up a D eve lopm ent En vironm ent for th e 2007 Micro soft Offi ce System.

Becau se a single deve lop er work s in each d eve lopm ent environm ent, all error log s, se rvices res tart s and failur es be long onl y to thi s deve lop er, making it mu ch ea sier to tra ck issues , troubl es hoot, andpro cee d. 3

In thi s environm ent, th e deve lop er ha s full authorit y, and no n e twork a spec ts ar e involved.Eve rything i s install ed lo cally, and th e deve lop e r ha s full control eve rywh ere .

The goal for thi s environm ent i s to fo cus on a spec ts of your bu siness . The point of view is to di vide

and conqu er.

3 Thank s to Gar y Bushey 7

Name : Deve lopm ent En vironm ent (MiniD ev)

De sc 8 ip tio n : Single-deve lop er, single-ma chin e deve lopm ent environm ent

Pu 8 po se : Enhan ce bu siness logic deve lopm ent

A tt 8 ibut e s: Single ma chin e , th e deve lop e r is a lo cal

admini strator ( can p e rform an y fun ction)

Co nt e nt : Deve lopm ent environm ent and tool s, se rvers

and se rvices or stub s





With Microsoft SQL Server and MOSS, the local, stand-alone development environment alsoincludes Visual Studio and other development components. Microsoft Office system client productsmay also be installed in a development environment.

For a complete description of deploying a development environment, see the references at the endof this article.

For more information on development lifecycle, see the Microsoft Solutions Framework (MSF)documentation.

Testing f o r the l oc al, stand-al o ne devel op ment envir onment

To ensure your development environment is providing what you need, you should do the following :

y Perform unit testing to ensure proper component functionality before moving on to anintegration environment.

y Use personas to test your user s experience in this early environment. A persona is anarchetype of a fictional user representing a specific group of typical users. Because a

SharePoint site may appear differently to various users, it is advisable to test it with variousroles.

y Troubleshoot your components or applications in an environment which does not have asource-level debugger such as Visual Studio, especially in production environments. Toprepare for this, produce a symbol (PDB) file along with your released binary, and enablelogging, tracing, and other instrumentation options.

y Because changed content will be migrated to later environments (such as authoring), planyour environment to avoid overriding content modified by authors in the authoringenvironment. For example, to prevent a content author from modifying a critical masterpage, you should use another master page for content authoring to avoid the critical masterpage from being overridden by user modifications.

If a project does not include any custom development, adevelopment environment is unnecessary, and the implementationshould be performed on the next environment (the integration

environment).

Do not develop security or networking-related components in a development environment, becausethis environment can lack security or secure networking aspects.

B EST P RA CTICES

Use the following best practices for the local, stand-alone development environment.

1. Plan ahead. Do not let the ease of use of SharePoint Products and Technologies guideyour development.

2. Until your code is running as expected, avoid using production components (such asActive Directory) in development environments.

3. Document your code with good comments for future problem solving.





4. Avoid logging events in the operating system event files, because in case of a problem it is hard to detect operating system issues. General logging practices are provided in thePatterns and Practices reference at the end of the article.

5. Clean up/dispose of SPW eb and SP Site objects (for more information, see BestPractices : Using Disposable Windows SharePoint Services Objects ).

6. Avoid using the SPW eb. A llowU nsafe Up date property, as setting this property to true can leave your code open to security risks, potentially introducing cross-site scriptingvulnerabilities.

7. Avoid any direct access to the SharePoint databases. (For more information, see Supportfor changes to the databases that are used by Office server products and by WindowsSharePoint Services ).Accessing these databases programmatically or manually can causeunexpected locking within Microsoft SQL Server that can result in overall performanceproblems.

8. For code access security, use the following table to help you determine where to installyour assemblies, either in the Bin directory or global assembly cache.

Bin Global assembly cacheTrust level As specified in web.config file.

Can specify detailed policies.Grants Full trust to your assemblywithout affecting the trust level of assemblies installed in the BINdirectory.

Scope /availability

Web application (InternetInformation Services (IIS) Website).

Affects the whole physical server.

Strong name Optional RequiredRequiresrestart

No Restart IIS or at least recycle theapplication pool each time yourecompile assemblies.

Tightensecurity

This option is less secure.Assemblies installed in the globalassembly cache are available to allvirtual servers and applications ona server running WindowsSharePoint Services. This couldrepresent a potential security riskas it potentially grants a higherlevel of permission to yourassembly across a larger scopethan is needed.

Licensing Licensing issues may arise due tothe global availability of yourassembly.

Upgrade fromSharePoint2003

Gradual upgrade does notupgrade items to the new \BINfolder, so you must redeploy yourWeb Parts.

Existence If a Bin directory does not exist, Exists



I m 9 @ A m A B C D B E MD c F G s G H C I P H H D c A Q R S F A T G D B C I Q A F U A F 2007S B V W D B V G X s I Q R S F A T G D B C I Q A F U D c A s 3 Y 0 Q G @ ` C D G B s a S B ` S F b 2008

© 2008 Micro soft Corporation. All right s rese rved. Pag e 12 By using or pro viding f ee dba ck on th ese mat erial s, you agr ee to th e atta ch ed license agr ee ment.

you mu st add on e . Do not stor e c

eb Part s in th e _app_bindir ec tor y.

For mor e information about cod e access sec urit y, see th e ref erences at th e end of thi s arti cle .

Environ me nt 2: Int e d ration

In thi s environm ent, you int egrat e th e compon ent with oth er compon ent s and t es t th e entir e pag e .e

h en a compon ent i s brought to thi s environm ent, you a ssum e that it s logi c is compl e te and ha s

bee n confirm ed via unit t es ting or a similar m echani sm. ( f ow compon ent s ar e brought into thi s en vironm ent i s addr esse d lat er in thi s do cum ent.)

In th e int egration en vironm ent, you addr ess sec urit y and n e twork a spec ts. You in stall clientprogram s on client comput ers, not on th e se rve r, to mat ch th e real produ ction en vironm ent.

Unlike in th e deve lopm ent en vironm ent, all impl em entation compon ent s in th e int egrationen vironm ent u se th e sam e se rvices (for e g ampl e , S h i Server or II S). Authorization i s similar to aprodu ction environm ent, and eve n topolog y, proxi es , and fir ewall s mu st b e tak en into con siderationin thi s environm ent.

In addition, you can u se thi s environm ent for customization s. Alternati vely, you could u se th e

authoring en vironm ent for customization. M e thod s for tran sf e rring customiz ed cont ent b e tw ee nth e environm ent s ar e desc rib ed in Chapt e r IV Impl ementation A ctivities .

Name : Int egration En vironm ent

De sc p ip tio n : A se rve r or se rve r farm, in th e sam e Active Direc tor y domain controll er a s th e deve lopm enten vironm ent.

Pup

po se : First int egration point b e tw ee n workingcompon ent s. Use for fun ctional t es ting of th e compl e te solution.

A tt p ibut e s: Single se rver or a farm, d epending on th e

impl em entation r equir ement s.



I m q r s m s t u v t w Mv c x y s y u v c s x s y v t u s x s x 2007t v t y s x s y v t u s x v c s s 3 0 y r u v y t s t x 2008


Environ me nt 3: Authoring

The authoring environm ent mu st b e an exact softwar e mat ch to th e produ ction environm ent, exce ptfor f eatur es such a s do cum ent con ve rsion that ar e requir ed for cont ent authoring.

You do not d eplo y sour ce cod e in thi s environm ent, and th e re ar e no d eve lopm ent tool s (except, if

nee ded, r emot e debugging compon ent s).

Cont ent i s author ed h ere, pr ef erabl y from a comput er whi ch contain s th e authoring tool s, and th endeplo yed to th e pilot and produ ction environm ent s.

This environm ent can al so b e use d for customization.

It is po ss ible to start with a ce rtain working m e thodolog y in on e environm ent, and chang e it or mo ve to anoth er environm ent lat er. For exampl e , a ssum e you customiz e th e pag es in th e authoringen vironm ent, and th en you tak e thi s en vironm ent to a di sconn ec ted n e twork on th e custom er site .You can now cop y the cont ent of thi s environm ent to th e int egration environm ent, r ese t th e authoring en vironm ent, continu e working in int egration, and continuou sly bring updat es to th e

authoring en vironm ent. Th e pro cess of mo ving cont ent (al so r ef err ed to a s deplo ym ent, migration,and so on) i s addr esse d in Chapt er IV Impl ementation A ctivities .

To re em

le pr oduc ti on, i ns t ll d evel op ed co m pon ent s i n t

e au t

ori ngenvir on me nt a fter t

e pass t

e i nte gr a ti on te st s.

Au t

ore d con te n t m ay a l so b e req uire d i n o t

er (d evel op me nt and i n te gr a ti on) envir on me nt s, p rim a ril y t o d etermi ne us er ex perie nc e and t o

perf o rm ot

er te st s. Ways t o m ove t

e con te n t betwee n envir on me nt s i s

d e sc ri bed l a ter i n t

i s docu me nt .

Name : Authoring En vironm ent

De sc ip tio n : A se rve r u se d for bu siness cont entauthoring.

Pu po se : Enabl e cont ent author s to edit and r ev iew

th e ir cont ent in th e earli es t, full y fun ctioning andstabl e environm ent.

A tt ibut e s: Can b e a single se rver.

Co nt e nt : Authoring tool s, con vert ers, andconfiguration s.



I m m j k Mj c l m s m n o n n j c l m j o l l 2007j m s o l m j o l j c s 3 0 m z j m s { z l | 2008


B}

S~

PRA CTICES

1. Choo se a single environm ent for customization, to a void confli cts and th e nee d forme rging updat es . Your d ec ision d epend s on con ce rn s such a s th e natur e of th e requir edcustomization, th e location of thi s environm ent (lo cal, r emot e, or di sconn ec ted), th e amount of exp ec ted modifi cation s, and th e ir fr equ ency.

Environ me nt 4: Pilot or e t

The softwar e install ed for thi s environm ent mu st mat ch th e softwar e install ed in th e produ ction

en vironm ent exactly

you should al so att empt to mat ch th e hardwar e in both environm ent s. If youwill b e condu cting str ess or load t es ts, th e hardwar e mu st al so mat ch that u se d in th e produ ctionen vironm ent.

Eve ry deplo ym ent i s tes ted in th e pilot environm ent b efor e it is appli ed to produ ction.

The pil o t envir on me nt shou l d re sem ble t he pr oduc ti on envir on me nt .Theref o re it m ay re si d e i n a rem ote or hos ti ng envir on me nt , o r ex hi bit o t her cha r ac teri sti cs w hi ch w ou l d m ak e te sti ng ha r d er t han i n ea rlier envir on me nt s.

I t i s ad vi sab le t o p erf o rm te st s as soon as t hey m ak e sens e .

A co m pre hens ive li st o f sugg este d te st s i s d efi ned l a ter i n Chap ter X - T e sti ng .

BEST PRA CTICES

1. Mak e th e pilot environm ent a s similar to th e produ ction environm ent a s po ss ible ,sothat you can ve rif y eve ry installation and configuration b efor e appl ying th em toprodu ction.

Name : Pilot (al so known a s Tes t) En vironm ent

De sc ip tio n : An environm ent for final t es ts, both forimpl em entation updat es and an y re lat ed produ cts ortec hnolog y updat es (such a s for

indow s, Shar ePoint

Produ cts and T echnologi es , S Server).

Pu po se : Minimiz e risk to produ ction environm ent b y simulating eve ry mo ve in ad van ce .

A tt ibut e s: Mu st b e identi cal to produ ctionen vironm ent in eve ry a spec t that ma y aff ec t softwar e

beha vior ( see th e following sec tion s).



I m m M c s c 2007 s c s 3 0 s 2008


2. In load -balan ced environm ent s, mak e sur e your t es ts don t stick to a single nod e .

3. Rem emb er that upon una vailabilit y, p erforman ce is no long er an i ssue. Performan ce is onl y on e aspec t to con sider.

Environ me nt 5: Produ c tion

The produ ction environm ent ma y be int ernal or exte rnal to th e organization. It mu st b e prop erly configur ed, both for sec urit y and p erforman ce . Its configuration mu st a ssur e a prot ec ted, high -availabilit y, w e ll-performing, updat eabl e en vironm ent, whi ch is thoroughl y monitor ed, can b e we ll

debugg ed and i s alwa ys on guard for di saster r eco ve ry situation s. A clear se rvice leve l agr ee m ent(S A) should b e spec ified for maint enan ce op e ration s.

See th e Micro soft Offi ce planning and d eplo yment arti cles on Micro soft T echN e t (Offi ce System) forguidan ce.

BEST PRA CTICES

1. Kee p th e RDP instru ction s and th e requir ed se tup kit s stor ed in anoth er lo cation, not onth e produ ction se rve r. Oth erwi se , wh en a produ ction sys tem i s offlin e , onlin e information i s ina ccess ible .

2. The pilot environm ent i s your t es t fie ld, not th e produ ction environm ent. But ongoingmonitoring should in clud e frequ ent (minimal impa ct) t es ts.

3. Kee p sampling p erforman ce for futur e compari son, to d e tec t slow d egradation of performan ce .

Name : Produ ction En vironm ent

De sc ip tio n : The goal of thi s me thodolog y.

Pu po se : Answer custom er r equir em ent s

A tt ibut e s: Server or se rve r farm, or se rvers with NOsour ce cod e , highl y sec ur ed and optimiz ed to m ee tcustom er n ee ds.

Co nt e nt : See planning and d eplo ym ent at Micro soft

Tec hNe t (Offi ce System).



I m m M c s ª « c ¬ ® ¯ ª ¬ ° 2007® ± ² ± ³ s ª ¬ ® ¯ ª ¬ ° c s 3 ´ 0 ¬ µ s ¶ ® µ ® · 2008


Environ me nt 6: Sour ce C ontrol or C onfiguration Manag eme nt

Micro soft Visual Studio T eam System ( VSTS) 2005 or 2008 can b e use d to stor e , tra ck, tes t, andmanag e th e impl em entation lif ecyc le . This includ es both Visual Studio d eve lopm ent and export s of

th e Shar ePoint artifa cts such a s ma ste r pag es , la yout s, and style shee ts.

As both th e pilot and produ ction environm ent s ma y be disconn ec ted from th e organization n e twork,pa ckag es ma y be pr epar ed in th e configuration manag em ent en vironm ent, u sing a formal buildpro cess , to b e deplo yed and updat ed in th e disconn ec ted en vironm ent s.

Using Team Foundation Serve r, t es ts that you condu ct in th e pilot environm ent ( eve n if r emot e) can

re turn th e res ult s to th e configuration manag em ent environm ent for anal ysis and r eporting.

BEST PRA CTICES

1. Deplo y cod e befor e artifa cts. So if an artifa ct (for exampl e , a Featur e) re lies on spec ific cod e , it will b e pr ese nt for a ctivation.

2. Dispo se of unu se d compon ent s be for e deplo ym ent to a n ext environm ent, in cludingclose d

¸

eb Part s, unu se d f eatur es and d efinition s, and so on.

3. Deplo y updat es to th e environm ent s (such a s se rvice pa cks) in th e sam e wa y you d eplo y

your impl em entation, starting with th e deve lopm ent environm ent s.

4. Kee p all environm ental d eplo yed updat es with your impl em entation updat es , anddo cum ent what th e updat e is, how you got it, from whom you got it, wh en you got it,and wh y you got it. E ven a Shar ePoint li st of such not es can save da ys of rese ar ch, trial,and e rror.

5. Docum ent eve ry deplo ym ent and t es t so that you can d e tec t an y degradation from th e updat e .

Name : Configuration Manag em ent ( Sour ce Control)

De sc ¹ ip tio n: Tes ting and storag e for all oth e r

environm ent s.

Pu ¹ po se : Build and t es t automation and manag edstorag e .

A tt ¹ ibut e s : Ma y be use d to automat e deplo ym ent,aft er success ful build, and ma y ha ve to work with

remot e pilot and d eplo yment en vironm ent s.

Co nt e nt : Visual Studio T eam System or anoth ersour ce control and t es t environm ent.



I m º » ¼ m ¼ ½ ¾ ¿ ½ À M¿ c Á Â s Â Ã ¾ Ä Å Ã Ã ¿ c ¼ Æ Ç È Á ¼ É Â ¿ ½ ¾ Ä Æ ¼ Á Ê ¼ Á 2007È ½ Ë Ì ¿ ½ Ë Â Í s Ä Æ Ç È Á ¼ É Â ¿ ½ ¾ Ä Æ ¼ Á Ê ¿ c ¼ s 3 Î 0 Æ Â » Ï ¾ ¿ Â ½ s Ð È ½ Ï È Á Ñ 2008


C omb in ed environ me nts

If you cannot d eplo y all th e se parat e en vironm ent s desc rib ed earli e r, you ha ve at l east th e followingen vironm ent s:

y A single environm ent in whi ch to p erform d eve lopm ent, int egration, and authoringy A pilot or t es t en vironm enty A produ ction environm ent

Ò

hen impl em enting a lo cal t eam site and eve n corporat e portal r equir ement s, you ma y not n ee d all

of th e en vironm ent s. Therefor e, spec if y your impl em entation sce nario at an earl y stag e of th e impl em entation so you know whi ch environm ent s you will n ee d.

See KB arti c le 909840 re ga r d i ng suppo rt f or MO SS 2007 and W i ndo w sSha reP oi nt Servi c es 3.0 i n p r oduc ti on on l y w hen us i ng M i c r oso ft V irt ua l S erver

2005 R2.

Now that w e ha ve defined th e deplo ym ent en vironm ent s, w e can d e fine th e deplo ym ent pro cess , or

how to automat e th e tran sf er of d eve lopm ent s, customization s, and cont ent b e tw ee nen vironm ent s.





B EST P RA CTICES

1. Match installations on all environments (apart from specific environment tools, such asVisual Studio in the development environment).

2. Keep a baseline virtual environment to check against when you encounter an

unexpected behavior in your implementation.3. Backup is the means, restoration is the target. Make a habit to restore regularly and

verify the restored environment, preferably using an automated batch test in whichresults appear on your favorite dashboard.

F or more information

Deployment, security, manageability, and other aspects of the environments described in thisdocument are beyond the scope of this document, but should be taken into account for everyenvironment. Information is available on Microsoft TechNet (Office System) .





C hapter IV - ImplementationActivitiesThe following table defines three levels of complexity of the implementation process : basic,intermediate, and advanced.

A ctivity Basic Level Intermediate Level A dvan ced LevelHOW TO DO? Manual

implementationthrough the WindowsSharePoint Services orMOSS UI and clientapplications.

Using Microsoft OfficeSharePoint Designerand basic scripting.

Using a developmentenvironment such asVisual Studio.

W HA T IS R EQ UIR ED? Requires contentmanagement control.

Requires source and configuration control, andthorough testing

All levels require means to transport updates between environment s andmanage content, source updates, versions, check-outs, and so on.

The following table describes sample activities, and their mapping to the various complexity levels.

A ctivity Basic Level Intermediate Level A dvan ced LevelA dding co ntent t o bep ublished

Use the WindowsSharePoint Services UIand client applicationsto author, add, andupdate content in pre-

defined content fields.A dding items su ch as acust o m list, co lumn, o rco ntent ty pe t o sites

Use the settings pagesin the WindowsSharePoint Services orMOSS UI for columns,content type, customlists, and so on.Create a list template(.stp) by using theWindows SharePointServices UI.

Create a Feature thatcontains a listdefinition.

Changing the

app earan ce o f anentire site

Change the master

page, theme, and soon.Create a site template.

Edit the master page,

theme, and so on.Create a site template.

R endering cust omco ntent on pages.

Use existing WebParts.

Edit the page layout. Develop a Web Part ora custom control.

R unning cust o m lo gic upo n item change

Use a built-inworkflow.

Create a no-codeworkflow inSharePoint Designer.

Create a Visual Studiocustom workflow.

Ex tending e xisting sites Create an object





w ith lists, W eb P arts,and s o o n

model script ordevelop a Feature.

Offering a cust om siteas an a pp licati o n

Create a site template.stp using theWindows SharePointServices UI

Create a site definitionbased on an onet.xmlfile.Use the solution

generator fromVSeWSS

Expo sing Share P o intdata t o a cust o mapp licati on

Query our RSS feeds Web services, FPRPC,Business Data Catalog,and so on.

Expo sing a pp licati ondata in Share P o intP rodu cts andTechn o lo gies

Save search queries.Use Business DataCatalog Web Parts.

Customize search UIand behavior.

Define and developBusiness Data Catalogitems, custom searchand applications, andpossibly use singlesign-on or customauthentication

provider.

Finally, we have components that are implemented in Visual studio (these usually reside in the filesystem), components that are provided within the scope of a site (these usually reside in theSharePoint database), and other components (such as components that were not developed byusing Visual Studio, and with a scope larger than a site collection). At this point, how do we transportall the components from one environment to another (providing we have more than a singleenvironment in our implementation)? In Chapter V - Deployments , we provide this information.





C hapter V - Deployment MethodsBefore describing deployment methods, review what you are going to deploy, as specified in theBackground section for development, customization, and content authoring.

You should also understand the various means of generating what you will deploy, so that you canoutline the transport mechanism. This outline is divided into three categories :

y Things that can be packaged as a Feature/ SOLUTIONy Content within the site collection scopey Everything else (such as the items specified in Beyond the scope of this document ), which is

not addressed in this document

In a Chapter VI - Tools for the Job , we discuss the tools for the job. For now we can assume we haveall the tools we need.

Things that can be packaged as a Feature/SOLUTION can be easily transported by using theSOLUTION Framework, while content within the site collection scope is best transported by contentdeployment. The next sections describe both approaches.

Assemblies re Ó uired for a deployment operation should reside in the target environment BEF Ô Õ E the process of using them begins. F or example, beforeyou activate a F eature, as part of a deployment process, ensure the F eature sassemblies exist in the target environment.

The SO LUTION Frame wo rk

The Windows SharePoint Services SOLUTION framework provides a way to bundle the componentsfor extending Windows SharePoint Services or MOSS in a new file, called a SOLUT ION file. ASOLUTION file is a cabinet or .CAB-based format with a .wsp extension. A SOLUTION is a deployable,reusable package that can contain a set of Features, site definitions, and assemblies that you canapply to a site, and that you can also enable or disable individually. You can also use the SOLUTIONfile to deploy the contents of a Web Part package, including assemblies, class resources, .dwp files,and other package components.

To deploy content using the SOLUTION framework :

1. Package a custom Web application into a SOLUTION.2. Copy the file to another front-end Web server.3. Add the SOLUTION to the database.4. Deploy the SOLUTION.

SOLUTIONs can contain the following :

y Feature definitionsy Site definitionsy Template pages and resources



I m Ö × Ø m Ø Ù Ú Û Ù Ü MÛ c Ý Þ s Þ ß Ú à á ß ß Û c Ø â ã ä Ý Ø å Þ Û Ù Ú à â Ø Ý æ Ø Ý 2007ä Ù ç è Û Ù ç Þ é s à â ã ä Ý Ø å Þ Û Ù Ú à â Ø Ý æ Û c Ø s 3 ê 0 â Þ × ë Ú Û Þ Ù s ì ä Ù ë ä Ý í 2008


y Res our ces y Globall y availabl e or Bin a sse mbli es

For mor e information, see Ar jun Ohri s pr ese ntation in th e Micro soft Offi ce System Deve lop ers

Conf erence, inî

indow s Shar ePoint Services 2007 : Site Definition s, Featur es , and SOLUTION

Deplo ym ent (î

S304 ).

To d eplo y a SOLUTION to a n ew farm, simpl y use th e STSADM -add solution -filenam e <path toSOLUTION file here> to upload th e SOLUTION to th e farm. Aft e r you upload th e SOLUTION, go into

th e "SOLUTION manag em ent" sec tion und er th e O p era tio ns tab in th e Central Admini stration Site ,and d eplo y th e SOLUTION.

For step-b y-step in stru ction s on how to mak e a SOLUTION file , see Chris John son s blog on ï owSOLUTION deplo ym ent ha s chang ed d eve lopm ent with Shar ePoint t echnologi es .

For information about th e SOLUTION fram ework, see th e following sec tion s of th e ð

indow s

Shar ePoint Services 3.0 SDK:

y SOLUTIONS Overview y Creating a SOLUTION y Deplo ying a SOLUTION y Upgrading a SOLUTION y Re tra cting a SOLUTION y Localizing a SOLUTION y SOLUTIONSchema





In addition to the SOLUTION framework, you can also use the following :

y Share P o int S o luti o n Generat o r: This stand-alone program generates a Site Definition projectfrom an existing SharePoint site. The program enables developers to use the browser and

Microsoft Office SharePoint Designer to customize the content of their sites before creatingcode by using Visual Studio. The Solution Generator is part of Windows SharePoint Services 3.0Tools : Visual Studio 2005 Extensions .

y The guide to Working with Features in the Windows SharePoint Services SDK with MikeAmmerlaan s explanation on The concept of a "Feature" in SharePoint .

y Share P o int Feature Manager: Provided on Todd Baginski s blog assists with the deploymentfeatures and also with other STSADM commands.

y The Solution Pack Generator and the WSPbuilder , which help in the creation and generation of SharePoint solution packages.

Co ntent De p lo yment/Migrati o n API

The content deployment/migration API deploys content and page modifications. This may be theresponsibility of the content author, who is not a developer and does not write scripts. However, if you are handling scheduled batch updates to published content, this type of content deploymentmay be performed by the farm administrator.

For these various scenarios, you may need a variety of content deployment methods. These aredescribed in the following table. The table focuses on the farm-level transports that are generallyapplied on a schedule, instead of the more local types of transports, such as using the content andstructure pages.

Co ntentDep lo yment

Content Migrati o n

Meth odCentralAdministration

STSADM Web Service Object Model (API)

Sour ce anddestinati onenvir o n-mentsco nne ctivity

Only connectedscenarios

Supports exportingspecified contentfrom a sourceWindowsSharePoint Servicessite collection to acabinet (.cab) file in

XML format.

jobName - Filename to use forcontent migrationpackages

Recommendedmethod indisconnectedscenarios 4

Scop eSites in a sitecollection

The entire Web siteonlyYou cannot pickindividual items orlists

The entire Web siteonlyYou cannot pickindividual items orlists

You can migrateanything, from aWeb site to an itemin a list, or a singledocument in a

4 When the pilot environment and production environment have no network connection to internal LAN. Thisis common in secured organizations and many others.





libraryGUIDs Don t retain Don t retain Retains

Usage

y Define path and job in thecentraladministration

pagesy Specify whether

or not to deployuser namesassociated withthe content andhow to deploypermissions onthe content

y Specify whetherto deploy allcontent, or just

content that hasbeen changed oradded

y Specify whetherto send e-mailwhen a jobsucceeds or fails

y Export andimportoperations

y To preservetimestamps,security info,and users, Usethe -includeusersecur ity parameter

y Expo rt W eb andImpo rt W eb methods in theSites Web

service

y Micro so ft.ShareP o int.De p lo yment namespace

y Specify settingsSP Ex po rtSettings andSPI mpo rtSettings objects

y Use areSP Ex po rt andSPI mpo rt

y You can choosewhether toincludeinformationabout security,

versioning, userroles, and othermetadataappropriate tothe objects youare migrating

R equiresCo de

No None or batch levelWeb serviceinvocation

Object model / API

Co mp lex ityAdministratorsettings

CommonSample batch

referenced

Most complexLess common

Most complexComplete sampleswith technicalarticles in the SDKs

N o tes

Easy to set aschedule for timelycontent updateSpecial QuickDeploy job for siteowners

Most useful whenthe goal is tomove basic contentfrom an entireWeb site or re-parenting a Website

Migrate data froma remote server

Provides the mostcontrol over yourdata migrationscenarios

How to A rti cles

Plan contentdeployment

How to : DeployContent BetweenServers

SharePoint ContentMigration ObjectModel and ContentMigration Packages

Sites Methods Export Web Import Web

How to : CustomizeDeployment forDisconnectedScenarios

How to : Migrate aWeb site from onelocation to another





W hat is migrated by using the content migration Añ ò

?

y Copies of content (original content is not migrated).y Web pages and resources used by the copied pages.y Any items in the content database that a deployed Web page depends on, such as images,

style sheets, or layout pages.y Dependent page layout and packages for a page even if the de pendent resources aren t in

the sa m e site .y Most recent major and minor versions of a content item.y Scheduling information for an associated item.y Web Parts (however, no assemblies are migrated; for custom Web Parts, install the DLLs at

the destination location for proper functioning).

W hat is NO T migrated using the content migration Aó ô

?

y Recycle Bin items and statey Alertsy Features and SOLUTIONSy Personal Viewsy Autocopy referencesy Web Part assembliesy Workflow instances and associationsy Anything outside the scope of the

SPW eb y Search index and contents

y Configuration information (such asweb.config files) or application data

y Audit traily Change log historyy Check-in/check-out statey Security statey Workflow tasks and statey File system modifications : CSS,

definitions (custom list and sitetemplates), etc.

T o perform the migration process

1. Prepare a blank site at the destination.2. Export content from the source site.3. Use VSTS to manage, version, and schedule deployment for the exported package , as you

would any code package ready to be moved to the destination.4. After moving the package to the destination, import the package into the site.

You can download a tool that will demonstrate export and import based on the object model, fromContent Migration API in Action . The tool has two versions :

y A GUI version (see the following figures)y A batch file version that you can run from a command line that depends on a settings file,

which can be prepared using the GUI version and can be used as a task in MSBuild



I m õ ö ÷ m ÷ ø ù ú ø û Mú c ü ý s ý þ ù ÿ þ þ ú c ÷ ¡ ¢ £ ü ÷ ¤ ý ú ø ù ÿ ¡ ÷ ü ¥ ÷ ü 2007£ ø ¦ § ú ø ¦ ý ¨ s ÿ ¡ ¢ £ ü ÷ ¤ ý ú ø ù ÿ ¡ ÷ ü ¥ ú c ÷ s 3 © 0 ¡ ý ö ù ú ý ø s £ ø £ ü 2008


EXP ORT

IMP ORT

In addition to m e thod s for th e cont ent d eplo ym ent and cont ent migration, th ere ar e also oth er

me thod s that can b e use d to cop y cont ent b e tw ee n site collec tion s.For mor e information, see th e following link s:

y Export or import a

eb pa ckag e (Micro soft Offi ce Shar ePoint D es ign er 2007 )

y Back up, r es tor e , or mo ve a Shar ePoint site (Micro soft Offi ce Shar ePoint D es ign er 2007 )

y Save a site a s a site templat e

y Shar e customization s by saving th em a s templat es

y Admini stering ba ckup and r ecove ry for Offi ce Shar ePoint Serve r 2007

y Admini stering ba ckup and r ecove ry for

indow s Shar ePoint Services 3.0 technolog y





y Plan for backup and restore (Office SharePoint Server)

y Migrate Office SharePoint Server 2007 by using built-in tools

y Migrate Office SharePoint Server 2007 by using Central Administration

y Migrate Windows SharePoint Services 3.0 by using built-in tools

y Plan for backup and restore (Office SharePoint Server) o Plan for tools

o Backup Strategies

o Plan for backup types and schedules

y Administering backup and recovery for Office SharePoint Server 2007

y Using Backup and Restore (Office SharePoint Server 2007)

y Migrate content or sites after upgrade (Office SharePoint Server)

y Troubleshoot backup and recovery for Office SharePoint Server 2007

Content migration is much slower than other methods for backing up and restoring content (such asSTSADM or SQL backup), because each object must be migrated rather than restoring objects inbulk. However, using the object model provides much greater control and offers a wide collection of parameters (as you can see from the tool API).





C hapter VI - Tools for the JobUse the following tools and resources for implementing your SharePoint solutions.

Devel op ment t oo ls

y MOSS and Windows SharePoint Services SDKs (see SDKs and Centers )y Visual Studio 2005 (see Dev Tools )y Windows SharePoint Services 3.0 Tools : Visual Studio 2005 Extensions (see Dev Tools )y Internet Explorer Developer Toolbar (see Dev Tools )

P ackaging t oo ls

y Windows SharePoint Services 3.0 Tools : Visual Studio 2005 Extensions (see Dev Tools )y MakeCAB (see Packaging Tools )y STSADMy Content Publishing demo tool (see Packaging Tools )y The Solution Pack Generator and the WSPbuilder

Cust o mizati o n t oo ls

y A supported browser (see Authoring and customization )y SharePoint Designer 2007

Co ntent auth o ring t oo ls

y A supported browser (see Authoring and customization )y Smart client authoring tools (see Authoring and customization )

Co ntent de p lo yment, staging, and migrati on t oo ls

y Content deployment (see Content Deployment )y Content migration API (see Windows SharePoint Services 3.0 Content Migration API)y The Content Migration API in Action

V irtual envir o nments

y May be used to achieve multiple environments to perform various implementationscenarios, from content sharing and authoring to development

y See notes on supportability in Virtualization

Testing and S our ce Contr o l

y Visual Studio Team System2005y Best Practices Analyzer (see Testing, Source Control and MSF )





y Data Population Tool (see Testing, Source Control and MSF )y Fiddler (see Testing, Source Control and MSF )

Additional tools can be found on http ://www.codeplex.com/ .





C hapter VII - ImplementationProject Plan and TeamThis section describes a sample implementation project plan. Activities are presented in the order inwhich they should be performed. For each activity, the team members who should participate areindicated.

ActivityWorkDays

A r c

h i t e c t

D e s i g n e r

D e v e

l o p e r

i n f r a s t r u c t u

r e s p e c i a

l i s t

B u s i n e s s

Milestones

Vision and scope Scope ApproveTo tal

Development environments planning

Development environments installation Readiness Training completedTo talPlanning - functional requirements

Planning - Non-functional requirements

Initial design

Integration and authoring environmentsplanning

Integration and authoring environmentsinstallation

Testing V1 prototype ApproveTo talPilot and production environmentsplanning

Pilot and production environmentsinstallation

Design

Application development

Deployment to integration, authoring andpilot environments

Pilot environment testing V2 prototype ApproveTo talDeployment to production environment,using a proven procedure

Production environment testing Project approvedTo talGrand To tal





C hapter VIII - ImplementationWorksheetThe following is a sample worksheet for use by a team implementing an enterprise portal or Internetsite based on MOSS 2007 :

A sp ect t o revie w Exam p les

V ision and s cop e ...

Imp lementati on go al Corporate portal, collaboration sites, Internet facing organizationsite, record management, archive, storage garage, etc.

N umber o f devel op ers

N umber o f designers

N umber o f co ntent auth o rsDevel op ment ty p es Web Parts, IFilters, Workflow

Cust o mizati o n ty p es Templates, definitions, master pages

Devel op ment t oo ls anddevel op ers skill set

Visual Studio 2005, SharePoint Designer

Cust o mizati o n t oo ls anddesigners skill set

Templates, definitions, master pages

Co ntent auth o ring t oo ls andauth o rs skill set

Templates, definitions, master pages

Sour ce co ntr o l Visual Studio Team System, Team Foundation Server, etc.Testing meth o do logies

V irtual ma chines

Terminal servi ces

Other co nstraints Low bandwidth, RAM and disk space in dev machines, etc.

Exp erien ce in Share P o int 2001 (v 1) , 2003 (v2), 2007 (v 3)

Exp erien ce in Mi croso ft . N ET Frame wo rk devel op ment

Microsoft .NET Framework 2.0,.NET Framework 3.0

Exp erien ce in

Web devel op ment

Microsoft .NET Framework

Time t o market Yesterday is not a valid answer

For more planning considerations (for example, expected volumes, update frequency, securityrequirements, production monitoring), see the following worksheets :

y Planning worksheets for Windows SharePoint Services 3.0





y Planning worksheets for Windows SharePoint Services 3.0 y Planning worksheets for Office SharePoint Server 2007 y Planning worksheets for Office SharePoint Server 2007





C hapter IX - HotfixesSome issues you encounter may require a hotfix. Because a hotfix is intended to correct only theproblem that is described in its article, apply it only to systems that are experiencing that specificproblem.

After release, a hotfix may receive additional testing and be included in a service pack. Therefore, if you are not severely affected by a problem, we recommend that you wait for the next service packthat contains this hotfix instead of installing an individual hotfix.

To look for hotfixes and updates you may need, use the following main resources :

y Newly published content for Office SharePoint Server 2007 y Newly published content for windows SharePoint Services y The Microsoft Hel and Support knowledge base advanced search functionality, for example :

y http ://support.microsoft.com/search/default.aspx?catalog=LCID%3d2057&spid=global&query=%22 Windows%20SharePoint%20Services%203.0%22&pwt=false&title=false&kt=PHRASE&mdt=186&res=100&ast=3&mode=a&adv=1&range=1-156

y http ://support.microsoft.com/search/default.aspx?catalog=LCID%3d2057&spid=global&query=%22Microsoft%20Office%20SharePoint%20Server%202007%22&adv=&ast=3&mode=a&cat=False&kt=P HRASE&title=false&mdt=186&pwt=False&res=100&range=1-163

If you need a hotfix, you can get it easily by submitting your requests at the Hotfix Request WebSubmission Form site . See a review at Microsoft Offers Customers Hot Fixes via E-mail .

If you conclude that you do need a fix, and you deploy it, consider it as part of the installation kit.Record its exact source (whether 32-bit or 64-bit,, language, and so on), and store it with all otherinstalled components.





C hapter X - TestingThe following is a common list of test areas for a server-developed solution. You may need onlysome of the tests for your implementation; however, you should review the list to ensure that you

don t overlook a test you might need.P reparation

Before you begin, be sure you have the following prepared for your tests :

y Working environment to be tested (client, server, other)y Client computer, strong enough to test the server or close enough to expected user

computer, to test the client applicationsy List of user names and passwords to be used in the tests (personas are a great way to ensure

that you test various user experiences; other tests might require a large number of each usertype)

y Preparation and capture toolsy A user who is authorized to install the testing tools on server and client computersy The following specifications :

y List of components composing the solutiony List of use cases to test and related actorsy User (or other) activities mix (such as search, browse, and upload document)y Activities frequency (minimum and maximum)y Authentication and authorizationy Security mechanisms (for example, Secure Sockets Layer [SSL])y Hardenings employedy Content volumesy Affecting activities (such as backup and index)y Expected concurrency or reentrancyy Topology (such as bandwidth or latency )y Special requests

Success criteria

Define your criteria for successful testing before testing starts, preferably having thecustomer create the definition, as this will influence the tests you employ, and the testingmethods. Success criteria should be measurable, such as the desired SLA and so on.

T ests

y Functionality ensure the right solution for the correct problemy UI by accepted design guidelines. Consider accessibility and localization globalization

aspectsy Security such as authentication, authorization, and input testsy Performance

o Baseline performance ensure the system exceeds performance goalso Load test determine the maximum number of a defined mix that conforms to a

defined performance goaly Reliability

o Exception management (for example, writing to a log when the disk is full)





o Stress test resources limits and proper releaseo Concurrency smooth functionality of multiple mixeso Special operations impact operation when affecting activities (such as backup)

occury High availability usually include both software and hardware aspectsy Scalability

o Concerns the growth of content, working hours, activity type ,and actorso A special case may be geo-scaling (such as spreading deployment to remote

locations with specific topology characteristics)y Troubleshooting

o Ability to troubleshoot in the production environment (such as use of debuggingtools, correct symbols, instrumentation)

y Manageabilityo Monitoring and problem alertso Backup (and restore testing!) verify service window length with expected volumeso Disaster recovery (from disconnection to complete system down)

y Documentation and operation guides (should also exist offline)o Installation documentationo User, operator, developer and other required documentationso Special and regular operation procedures





C hapter XI - SummaryThis document described an approach to implementing a SharePoint solution and some content and

the techniques to use.

Beginning with implementation scenarios, and the tools to achieve them, the document outlined a

methodology to divide and conquer so that you can accelerate development. It also specified the

mechanisms to move the content (transform the ingredients) from one environment to another.

The approach outlined herein attempts to provide you with a safe and forward-movingmethodology. The goal is to maximize stability and consistency of content within the servers, andrehearse the process enough to ensure that, when you get to production environment, you knowyour way, and can minimize the risk to damage this environment.

This document is only a high-level overview with some technical references. This document assumes

you have addressed proper manageability, including but not limited to backup and restore,monitoring, proper configuration for performance and security, and other aspects that must beconsidered in both development and production environments.For more information on thoseaspects, see Microsoft TechNet (Office System) .





C hapter XII - GlossaryTerm Des crip tio n and referen ces

Share P o intP rodu cts andTechn o lo gies

Term to refer to both Microsoft Office SharePoint Server (MOSS) and WindowsSharePoint Services 3.0

Microsoft OfficeSharePoint Server(MOSS) 2007

Integrated suite of server capabilities that can help improve organizationaleffectiveness by providing comprehensive content management andenterprise search, accelerating shared business processes, and facilitatinginformation-sharing across boundaries for better business insight. MOSS 2007supports all intranet, extranet, and Web applications across an enterprisewithin one integrated platform, instead of relying on separate fragmentedsystems. Additionally, this collaboration and content management serverprovides IT professionals and developers with the platform and tools theyneed for server administration, application extensibility, and interoperability.

(Microsoft Office SharePoint Server 2007 product overview )

WindowsSharePointServices

Versatile technology that organizations and business units of all sizes can useto increase the efficiency of business processes and improve teamproductivity. With tools for collaboration that help people stay connectedacross organizational and geographic boundaries, Windows SharePointServices gives people access to information they need.

Built on Windows Server 2003, Windows SharePoint Services also provides afoundation platform for building Web-based business applications that can flexand scale easily to meet the changing and growing needs of your business.Robust administrative controls for managing storage and Web infrastructure

give IT departments a cost-effective way to implement and manage a high-performance collaboration environment. With a familiar, Web-based interfaceand close integration with everyday tools including the Microsoft Officesystem, Windows SharePoint Services is easy to use and can be deployedrapidly.

(Windows SharePoint Services 3.0 Overview )

SOLUTION frame wo rk

Provides a way to bundle all of the components for extending WindowsSharePoint Services or Office SharePoint Server in a file, called a SOLUTION file.A SOLUTION file is a cabinet or .CAB-based format with a .wsp extension. ASOLUTION is a deployable, reusable package that can contain a set of features,site definitions, and assemblies that you can apply to a site, and can also

enable or disable individually. You can use the SOLUTION file to deploy thecontents of a Web Part package, including assemblies, class resources, .dwpfiles, and other package components. ( Solutions Overview )

Imp lementati on SharePoint related development, customization, and content authoring.

Devel op ment Code component that integrates with SharePoint Products and Technologies.

Most frequent uses of code are Web Parts and controls, but there are manyothers, such as custom workflows, custom event handlers, externalapplications, Features, and more.





Cust o mizati o n Development of content-related artifacts such as master pages, style sheets,and layout pages. Was originally denoting a wide user-modification (usually byadministrator), as opposed to personalization (performed by and for a singleuser).

In SharePoint Products and Technologies, a lot more can be accomplished via

the browser, and in SharePoint Designer, without using any traditionaldeveloper tool (for example, Visual Studio) and the scope of customizationmay be wider than a single Web site.

Co ntent auth o ring Publishing related term that refers to adding and updating content in presetcontainers within a Web page, and specifying content properties, such aspublishing and expiration time, searchable meta-tags, and so on

Content authoring may also involve several languages and span severalcorrelated Web pages, and MOSS provides the tools and guidance for suchactivities.

Micro so ft Offi ceShare P o int

Designer

Part of the 2007 Office system applications. The successor of Microsoft OfficeFrontPage® 2003 and the recommended customization client tool for

SharePoint Products and Technologies.V irtualizati o nso luti o n

Capability to enable IT managers to run multiple operating systems,applications, and middleware on a single physical computer, allowingcustomers to cut costs and response time without sacrificing resources.(Microsoft Virtualization )





C hapter XIII - ReferencesV irtualizati o n

y Virtual Server 2005 R2 Support for WSS 3.0 and MOSS 2007

Although there was no support for virtual environments in Microsoft Office SharePointPortal Server 2003 and Windows SharePoint Services 2.0 in KB 909840 , there is now productsupport for Windows SharePoint Services 3.0 and MOSS 2007 with Microsoft Virtual Server2005 R2 x86 or x64 . You can download it for free or order a CD .

y Virtual PCAlthough Microsoft Virtual PC might be used by product support for reproducing issuesor innonproduction environments, there is no support for Virtual PC. Do no t run W ind ow sShare P o int Servi ces 3.0 and Offi ce Share P o int Server 2007 p ro du ctio n envir o nments w ithV irtual P C. Support for third-party virtualization is similar to earlier SharePointreleases. Please refer to KB 897615 . It's possible that product support will require you toreproduce an issue in an environment that is not virtualized, if they suspect that the virtual

environment is a potential contributing factor in the issue. y Windows SharePoint Services, SharePoint Portal Server 2003, and SharePoint Server 2007 do

not support Virtual PC and Virtual Server for production environments Virtualization is supported for production when using Microsoft® Virtual Server 2005 R2for : o Windows SharePoint Services 3.0o MOSS 2007Review the article for important notes on options that are not supported.

y Support policy for Microsoft software running in non-Microsoft hardware virtualizationsoftware

y Microsoft Virtual Server 2005 R2o Overview o Download or Order for Free o Virtual Server 2005 Migration Toolkit

y Microsoft Virtual PC 2007o Overview o Demo o Download

SDKs and Centersy Online

o Windows SharePoint Services

o MOSS y Download

o Windows SharePoint Services 3.0 : Software Development Kit (SDK) Contains conceptual overviews, programming tasks, samples, and references toguide you in developing solutions based on Windows SharePoint Services 3.0.

o SharePoint Server 2007 SDK : Software Development Kit and Enterprise ContentManagement Starter Kit





Contains conceptual overviews, How Do I ? programming tasks, developer tools,code samples, references, and an Enterprise Content Management (ECM) starter kitto guide you in developing solutions based on MOSS 2007.

y Centerso SharePoint Server 2007 Developer Portal

Microsoft Office SharePoint Server developers' home on MSDN. Find informationabout planning, coding, building, deploying, and migrating solutions for SharePointServer.

o Windows SharePoint Services Developer Center Windows SharePoint Services continues to provide the solution platform for thenext version of Microsoft SharePoint Products and Technologies. WindowsSharePoint Services 3.0 takes full advantage of Microsoft ASP.NET 2.0 and the coreMicrosoft .NET Framework 2.0 runtime. The new features and addedprogrammability support in Windows SharePoint Services 3.0 provide a wealth of development opportunities.

o Governance Information for SharePoint Server 2007 Governance is the set of roles, responsibilities, and processes that you put in place inan enterprise to guide the development and use of a solution based on SharePointProducts and Technologies.

This page contains tools and resources to help business decision makers and ITprofessionals govern their SharePoint Products and Technologies environment. Byusing the governance techniques and best practices available from this page, anenterprise can align its policies for using SharePoint Products and Technologies withits culture and goals while still enabling teams and individuals to effectively

collaborate and share information.o Channel9 Screencasts o Office Developer How-to Center

This section of the portal compiles task-based samples that will help you learn thenew features of the 2007 Microsoft Office system programs, servers, services, tools,and technologies. Each sample is a short walkthrough that showcases one feature.By integrating several of these code samples together, you can start building OfficeBusiness Applications on the 2007 Microsoft Office platform.

Dev Too ls y Visual Studio Products

o Microsoft Visual Studio Team System 2005o Microsoft Visual Studio 2005 Professional Editiono Microsoft Visual Studio 2005 Tools for the 2007 Microsoft Office Systemo Microsoft Visual Studio Standard Editiono Microsoft Visual SourceSafe 2005o Microsoft Visual Studio Express Editionso Microsoft Visual Studio 2005 Tools for Applications





o Subscriptionsy Windows SharePoint Services 3.0 Tools : Visual Studio 2005 Extensions

Visual Studio 2005 Project Templateso Web Parto Team Site Definitiono Blank Site Definitiono List Definition

Visual Studio 2005 Item Templates (items that can be added into an existing project)o Web Parto Custom Fieldo List Definition (with optional Event Receiver)o Content Type (with optional Event Receiver)o Module

Review the download details page for important additional information.y Internet Explorer Developer Toolbar

Provides a variety of tools for quickly creating, understanding, and troubleshooting Webpages.

y Windows SharePoint Services 3.0 Sample : Example Master Pages Four sample master page sets compatible with the Application Templates for WindowsSharePoint Services 3.0 that show some of the customization options master pages provide.

y Windows SharePoint Services 3.0 Application Templates : All Templates Forty of the application templates for Windows SharePoint Services 3.0 plus the ApplicationTemplate Core solution, which is required to deploy server administration templates.

P ackaging Too ls y Windows SharePoint Services 3.0 Tools : Visual Studio 2005 Extensions

SharePoint Solution Generatoro Stand-alone program that generates a Site Definition project from an existing

SharePoint site. The program enables developers to use the browser and OfficeSharePoint Designer to customize the content of their sites before creating code byusing Visual Studio.

y MakeCABo http ://search.live.com/results.aspx?q=site%3Amicrosoft.com++sharepoint+2007+m

akecab&src=IE-SearchBox o Solution Deployment with SharePoint 2007 o Office Visual How To - Creating a Solution Package in Windows SharePoint Services

3.0 o Development Tools and Techniques for Working with Code in Windows SharePoint

Services 3.0 (Part 2 of 2) y Content Migration API in Action demo tool

When running the application, look at the session log on the right side of the screen. It liststhe properties used in the deployment and may help you develop your own tools.





SOLUTION Frame wo rk y SOLUTIONS and Web Part Packages

This section of the Windows SharePoint Services 3.0 SDK provides information about theWindows SharePoint Services solution framework. Use solutions to package and deploycustom Features, site definitions, templates, Web Parts, and assemblies.

y Creating a Windows SharePoint Services 3.0 Web Part Using Visual Studio 2005 ExtensionsLearn to use the project templates included in Microsoft Visual Studio 2005 Extensions forWindows SharePoint Services 3.0 to speed your Web Part development.

y How SOLUTION deployment has changed development with SharePoint technologies

The Windows SharePoint Services solution framework provides a way to bundle together allof the components for extending SharePoint in a new file called a solution file (a CAB-basedformat with a WSP extension). A solution is a deployable, reusable package that can containa set of features and site definitions, templates, Web Parts, and assemblies that you canapply to a site, and individually enable or disable.

The Solution Framework also deploys the solution to A LLfront-end Web servers in the farmwithout the administrator performing this on each computer manually

y SOLUTION deployment Configure your Visual Studio 2005 project, using MSBuild and MakeCAB.exe, to create the*.WSP file for you.

y See Arjun Ohri in the Microsoft Office System Developers Conference , in WindowsSharePoint Services 2007 : Site Definitions, Features, and SOLUTION Deployment ( WS304).The Microsoft Office System Developers Conference 2006 featured more than 60 breakout

sessions organized in eight technical tracks. From the new servers to the OpenXML Formats,to new client user interfaces and extensibility tools, there's a lot to tell you.

Bin o r Glo bal A ssembly Ca chey Microsoft Windows SharePoint Services and Code Access Security (SharePoint 2003

technical articles)Learn how to implement policies for code access security for SharePoint Products andTechnologies and how to customize default security settings for Windows SharePointServices. This document also answers some of the most commonly asked questions aboutcode access security and its applicability to Windows SharePoint Services.

y Creating a Basic Web Part (SharePoint 2003 technical articles)This programming task provides the steps for creating a basic custom Web Part that you canadd to your Web Part Page. It is a very simple Web Part that allows you to change the WebPart's Title property. The Title property is a Web Part base class property that sets the text inthe part's title bar.





y A Developer's Introduction to Web Parts (Microsoft Office SharePoint Portal Server 2003technical articles)Learn what Web Parts are and how to create them. Developers can build Web Parts asASP.NET custom controls. Administrators can install Web Parts on any site based onWindows SharePoint Services. Users can add Web Parts to pages by dragging and droppingin a browser, and they can personalize them by setting properties. Web Parts can connect to

other Web Parts using standard interfaces.

Featuresy Working with Features

Features reduce the complexity involved in making simple site customizations, and arerobust when upgrades are applied to a deployment. Features eliminate the need to copylarge chunks of code to change simple functionality. Features thus reduce versioning andinconsistency issues that may arise among front-end Web servers. Features make it easier toactivate or deactivate functionality in the course of a deployment, and administrators caneasily transform the template or definition of a site by simply toggling a particular Feature

on or off in the user interface.

y Troubleshooting Feature and Site Definition Development This troubleshooting topic can help you determine a cause if you find that the changes youintend to make through a definition or Feature do not take effect.

y Todd Baginski s blog SharePoint Feature Manager This application allows you to easily manage Features on your SharePoint server farm,without using the command line.

A uth o ring and cust o mizati o ny For a list of supported browsers, see :

o Plan browser support (Office SharePoint Server) o Plan browser support ( Windows SharePoint Services)

y Smart Client Authoring Smart Client Authoring (SCA) allows you to take a document stored in a SharePoint libraryand convert it into a Web page. Authors can easily do this on any document in SharePointProducts and Technologies, provided it s saved in a supported format.

Co ntent De p lo yment / Migrati o n

Content Deployment

y Deploying Content between Servers MOSS 2007 provides a rich deployment user interface. Most deployment scenarios can beaccomplished by an IT professional through the user interface, without the need for scripts.However, you can still use the object model to handle other scenarios, such as deploying





content between servers that are not on the same network or writing scripts to automatecommon tasks. This topic provides an overview of the MOSS 2007 content deploymentfeature and gives developers the background and resources necessary to build andimplement custom deployment solutions.

y How to : Customize Deployment for Disconnected Scenarios Content deployment works well when a clear connection between the source farm and thedestination farm is always available. However, a reliable, functional connection between asource authoring farm and a destination production farm is not always available. Forexample, geographic barriers, firewalls that prevent access, or network outages are allsituations in which using a network connection to transport an export package to adestination production farm is not reliable. In these situations, Microsoft recommends thatyou work with the MOSS 2007 object model and the Windows SharePoint Services 3.0Content Migration API to programmatically complete the export and import steps of contentmigration and find an alternative way to transport the export package to the destinationproduction farm and then run the custom import code.

y Plan content deployment Content deployment copies content from a source MOSS 2007 site collection to adestination site collection. The entire source site collection can be copied, or a subset of sites can be copied. In either case, content deployment is incremental by default, deployingonly changed pages and related assets (such as images).

y Design content deployment topology Content deployment copies content from a source MOSS 2007 site collection to adestination site collection, either based on a schedule or manually. This article describeselements of topologies designed for content deployment and shows typical contentdeployment topologies. For an overview of content deployment using MOSS, see Plancontent deployment .

y Plan content approval and scheduling In addition to planning how much control you want users to have over altering theappearance of your MOSS 2007 Web site, you also need to plan how much governance youwant content contributors to have over your site content. Governance refers to the rulesand processes that you want to establish for your site. For example, you may want users toimpose restrictions and functionality when authors create content. You have the option of giving users no control, simple moderation, or the ability to start a workflow after theysubmit content. You can also plan restrictions on where and what type of content an authorcan place in certain areas of your site.

y Enable access for end users (Office SharePoint Server) After you create your site collection and populate it with content, you are ready to grantaccess to end users. This article helps you configure administrative and user permissions fora site collection. You can also configure permissions for the following securable objectswithin a site collection : site, list, library, folder, document, or item. For more informationabout assigning permissions for different securable objects within a site collection, see Plansite security (Office SharePoint Server) .





y Content Migration Overview The Content Migration APIs provide a simple but flexible solution for migrating contentbetween Windows SharePoint Services Web sites. You can export the content related to aWindows SharePoint Services Web site, along with any dependencies (for example, security,roles, versioning, workflow, and other metadata), into single or multiple XML-formatted filescalled content migration packages. On import to the destination Web site, the packageddata is extracted and interpreted. You can also save the packages to a file server beforemigrating to a different server.

y The official blog of the SharePoint Product Group - Content Deployment Content Deployment takes care of transporting the content across the wire for you andinstantiates the remote import as well.

y Migrate content or sites after upgrade (Office SharePoint Server) After you have completed the upgrade process, you can redistribute content or sites asneeded to fit your new environment. It is easiest to move content or sites before you openthe sites to users again, so that they do not have to experience more than one outage

window.

W indows Share P oint Services 3.0 Content Migration API

Object Model

y Microsoft.SharePoint.Deployment Namespace y SPExportSettings Properties y SPImportSettings Properties y SPExport Class y SPImport Class y How to : Deploy Content Between Servers y How to : Migrate a Web site from one location to another

W indows Share P oint Services 3.0 Content Migration W eb Service

y Sites Web Service y Sites.Export Web Method (Sites) y Sites.Import Web Method (Sites)

S T S ADM

y Export : Stsadm operation (Office SharePoint Server) y Import : Stsadm operation (Office SharePoint Server)

Team Devel op menty Team-Based Development in Microsoft Office SharePoint Server 2007

Learn to properly conduct team-environment development of Microsoft Office SharePointServer 2007 sites and assemblies ( Web Parts, site templates, custom list templates), as wellas develop Microsoft Office SharePoint Designer artifacts (master pages, workflows, CSSsheets).





y Conduct Team-Based Development of Windows SharePoint Services and SharePoint PortalServer Applications (SharePoint 2003)Learn to conduct team-based development of Windows SharePoint Services and MicrosoftOffice SharePoint Portal Server 2003 based applications. These applications can includecustomized Web Part Pages, Web Parts, supporting Web applications, and Web services.

y Walkthrough : Creating a Custom Enterprise Search Web Part With Enterprise Search in Microsoft Office SharePoint Server 2007, you can customize thelook and functionality of the Search Center pages and Web Parts from the browser.However, if you want to make customizations that are not possible through the browser,you can create custom Web Parts that use the Query object model to execute queriesagainst the search component.

In this walkthrough, you'll create a custom search Web Part and add it to your site. The WebPart described in this walkthrough provides very basic search functionality.

y Setting Up a Development Environment for the 2007 Microsoft Office System

Learn how to set up a development environment for the 2007 Microsoft Office system.Create sample projects that demonstrate the types of application solutions that you cancreate using this system.

Testing, S o ur ce Co ntr o l and MSF

T esting

y Microsoft Best Practices Analyzer for Windows SharePoint Services 3.0 and the 2007Microsoft Office System Use this tool to create detailed reports to help administrators achieve greater performance,scalability, and uptime.

y SharePoint 2007 Test Data Population Tool and the article : Tools for performance andcapacity planning (Office SharePoint Server) This tool is a capacity planning and performance testing tool that populates data for testingSharePoint deployments. The SharePoint 2007 Test Data Population Tool is available as acommand-line executable program that extracts information about how to populate theserver from an XML configuration file, and calls Microsoft .NET Framework assemblyWSSDWLib.dll. The tool is explained in the article Tools for performance and capacityplanning (Office SharePoint Server) .

y Visual Studio Testing Testing is the process of examining an application to ensure it fulfills the requirements forwhich it was designed and meets quality expectations. More importantly, testing ensuresthe application meets customer expectations.

y Black Box and White Box Testing for Application Blocks Detailed overview of structural testing (white box testing) and output testing (black boxtesting) an application block, addressing subjects such as code path profiling,instrumentation, and testing external interfaces.

y Testing Methodologies An introduction to various test methodologies with an example around test-drivendevelopment.





y Design Review for Application Blocks Describes how to perform design reviews for an application block for functional,deployment, performance, scalability, security, and globalization considerations.

y Checklist for Testing SharePoint Web Parts Use this checklist to assist with the deployment and maintenance of SharePoint Productsand Technologies Web Parts.

y Best Practices for Developing Web Parts for SharePoint Products and TechnologiesUsing the programming model behind Windows SharePoint Services, you can create yourown Web Parts that provide new functionality to enhance your Web Part Pages. Learn bestpractices to improve performance and usability of Web Parts, and ways to create Web Partsthat integrate well with other components of a Web Part Page.

y The Fiddler Fiddler is an HTTP debugging proxy which logs all HTTP traffic between your computer andthe Internet. Fiddler allows you to inspect all HTTP Traffic, set breakpoints, and "fiddle" withincoming or outgoing data. Fiddler includes a powerful event-based scripting subsystem, andcan be extended using any Microsoft .NET Framework language.Fiddler is freeware and can debug traffic from virtually any application, including InternetExplorer, Mozilla Firefox, Opera, and others.

Source Control and Microsoft Solutions F ramework

y Building the Avanade Software Lifecycle Platform using Visual Studio 2005 Team System Microsoft Visual Studio Team System 2005 is an extensible lifecycle tools platform that helpssoftware teams collaborate to reduce the complexity of delivering solutions. The purpose of this paper is to describe how Avanade is building a value-added software lifecycle platformusing Visual Studio Team System. The intended audience for this paper is softwaredevelopers and project managers.

y Integrated Software Development at Microsoft Using Visual Studio 2005 Team System

Microsoft Visual Studio Team System 2005 provides an integrated software developmentenvironment that enables the Microsoft eBusiness Integration Services business-to-businessIT development group to incorporate the complete Microsoft IT Software Development LifeCycle (SDLC) process in one solution.

y MSF Sample Project Lifecycle Deliverables Download sample project lifecycle deliverables that work with the Microsoft SolutionsFramework (MSF) lifecycle version 3.0.

P atterns and P ra cticesy Logging Application Block

This page provides an overview of the Enterprise Library Logging Application Block. Anapplication block is reusable and extensible source code-based guidance that simplifiesdevelopment of common logging functionality in Microsoft .NET Framework applications.

y Microsoft patterns & practices This page contains deep technical guidance and tested source code based on real-worldexperience. The technical guidance is created, reviewed, and approved by Microsoft





architects, product teams, consultants, product support engineers, and by Microsoftpartners and customers. The result is a thoroughly engineered and tested set of recommendations that you can follow with confidence when building your applications.





C hapter XIV - C redits and ThanksTo

y Arjun Ohri , Program Manager, Windows SharePoint Servicesy Joel Oleson, Senior Product Managery Tyler Butler, Program Managery Jackie Bodine, Consultanty Mike Ammerlaan, Program Manager, Windows SharePoint Servicesy Chris Johnson, Program Managery All authors of technical articlesy Yaron Ben Shalom, CTO, Tvuna-Milleniumy Robert L. Bogue, MS MVPy Andrew Connell, MVP, Microsoft Office SharePoint Servery Todd S. Baginski, Vice President, SharePoint Expertsy Gary A. Bushey, MOSS MVP




The information contained in this document represents the current view of MicrosoftCorporation on the issues discussed as of the date of publication. Because Microsoftmust respond to changing market conditions, it should not be interpreted to be acommitment on the part of Microsoft, and Microsoft cannot guarantee the accuracy of

any information presented after the date of publication.

This document is for informational purposes only. MICROSOFT MAKES NO WARRANTIES,EXPRESS, IMPLIED OR STATUTORY, AS TO THE INFORMATION IN THIS DOCUMENT.

Microsoft may have patents, patent applications, trademarks, copyrights, or otherintellectual property rights covering this document or the subject matter included in thisdocument. The furnishing of this d ocument does not give you any license to thesepatents, trademarks, copyrights, or other intellectual property.

© 2008 Microsoft Corporation. All rights reserved.

implementing moss and windows share point services solutions

Documents