SPDocGen SharePoint Documentation Generator Walkthrough

1
SPDocGenSharePoint Documentation
GeneratorWalkthrough

• http//spdocgen.codeplex.com

2

• Agenda

• Introductions, Me and Ignia
• SPDocGen Demo
• SPDocGen Architecture Overview
• SPDocGen Code Walkthrough
• SharePoint Administration Tips
• Database and Service Account Management
• SharePoint Development Tips
• SharePoint Object Disposal
• Q and A

3

• Sezai Ignia

• Sezai Komur is a SharePoint Server MVP, Lead of
  the Perth SharePoint User Group and works at
  Microsoft Gold Partner Ignia as a SharePoint
  Solutions Architect. Over 8 years industry
  experience, he has worked with SharePoint for 5
  years including over 3 years with MOSS 2007 and
  WSS 3.0
• Ignia
• For over ten years Ignia has been a leading IT
  solutions provider in Perth. Ignia's core
  expertise includes
• - Enterprise Resource Planning (ERP),
  Accounting and CRM software
• - Document and Knowledge Management systems
• - Intranet and Website development
• - Business Intelligence and reporting solutions
• - Bespoke software and database solutions
• - Systems Integration

4

• SPDocGen

• SPDocGen uses the SharePoint Object Model API to
  gather information from a SharePoint Farm to
  produce an XML file. The XML file is then
  transformed into a Word DOC file containing farm
  documentation that otherwise would take much
  longer to document manually
• The tool and full source code can be downloaded
  from http//spdocgen.codeplex.com

5

• SPDocGen

• Lets Run it!
• DEMO

6

• SPDocGen Architecture

Sezai.SPDocGen A Class Library Project with 4
classes Sezai.SPDocGen.Console A Console
Application that references the Sezai.SPDocGen
class library project and contains the XSLT
transform
7

• SPDocGen Code Walkthrough

• Lets Have a Look at the Code!

8

• Database Management Tips

• 100 GB Content Database Size Guidance
• You can have multiple content databases storing
  data for one web application.
• Data for one Site Collection lives in one Content
  Database.
• Multiple Site Collections can exist in one
  Content Database
• You can setup multiple Site Collections in one
  Web Application, each with their own Content
  Database
• Setup Explicit Managed Paths and add Multiple
  Content Databases to a Web Application

9

• Demo

Explicit Inclusion Managed Paths Creating
multiple Site Collections and Content Databases
in one Web Application to improve
scalability Database Autogrowth Settings DEMO
10

• Account and Password Management

• Thats right folks, you can retrieve Application
  Pool Identity Passwords with the SharePoint
  Object Model API
• At a minimum, use a separate dedicated account
  when setting up and configuring SharePoint
• DO NOT EVER SETUP SHAREPOINT WITH YOUR DOMAIN
  ADMINISTRATOR ACCOUNT!
• As a best practice, use the full set of 8
  service accounts in your production environment.
  http//technet.microsoft.com/en-us/library/cc26344
  5.aspx
• Admins managing AD dont like to create so many
  accounts.
• Use different passwords for different accounts in
  production.

11

• Service Account Management Cont.

• If someone knows your SharePoint Service Account,
  and the account policy locks access after
  incorrect attempts they can bring down your
  SharePoint Farm.
• Make things easier for yourself in DEV ?
• Simplified Dev/Test Accounts http//www.trinkit.
  co.nz/blog/archive/2009/06/21/installation-account
  s.aspx
• Admin (SPAdmin) - Used for installation and
  administration of SharePoint
• App Pool  (SPAppPool) - all web apps except
  central admin run with this account as their
  identity
• Services (SPService) - App pool account for
  central admin and the SSP service account
• Search (SPSearch) - Used for all search services

12

• Disposing SharePoint Objects and Memory
  Leakage

• Object disposal can be confusing in Web Parts and
  Server Controls running on a SharePoint Page.
• Only dispose objects your code owns Disposing
  objects not created by you can cause adverse
  affects and errors. (such as from
  SPContext.Current.Web)
• How do you know If you created it?
• Disposal is a very SERIOUS problem, this can
  cause serious havoc on a SharePoint Server under
  load use the SPDisposeCheck tool to identify
  problems

13

• Disposing SharePoint Objects Continued..

• The three most common cases where you do own the
  object
• (via Keith Dahlbys blog solutionizing.net)
• 1. When you create your own SPSite object
  SPSite site new SPSite(url)
• 2. When you explicitly call SPSite.OpenWeb()
  SPWeb web site.OpenWeb(url)
• 3. When you iterate through SPSite.AllWebs
• foreach(SPWeb web in site.AllWebs) //
  web.Dispose()
• foreach loops using SPWeb can magnify memory leak
  issues.
• http//blogs.msdn.com/rogerla/archive/2008/02/12/s
  harepoint-2007-and-wss-3-0-dispose-patterns-by-exa
  mple.aspx
• http//blogs.msdn.com/rogerla/archive/2009/01/14/t
  ry-finally-using-sharepoint-dispose.aspx
• http//blogs.technet.com/stefan_gossner/archive/20
  08/12/05/disposing-spweb-and-spsite-objects.aspx
• http//solutionizing.net/2008/12/06/the-new-defini
  tive-spsitespweb-disposal-article/

14

• SPDisposeCheck

Lets Run it! DEMO
15
Thats all folks.

• Questions?