Upgrade your Internet Experience
Microsoft.com
Welcome Sign in
SharePoint Products TechCenter
Click to Rate and Give Feedback
TechNet
TechNet Library
Office
Operations
 Installing SharePoint Administratio...
Installing SharePoint Administration Toolkit (Office SharePoint Server)

Updated: 2009-08-27

System Requirements

The SharePoint Administration Toolkit requires Microsoft Office SharePoint Server 2007 or Windows SharePoint Services 3.0 to be installed, as well as the April 2009 Cumulative Update.

  • All previously installed versions of the Toolkit must be uninstalled before upgrading to the latest version. For more information, see Uninstalling SharePoint Administration Toolkit (Office SharePoint Server).

  • Membership in the following groups are required to install each tool:

    • Batch Site Manager, Permission Reporting Tool, UpdateAlert, UpdateQuota, and UnlockFGPReport: Farm administrator

    • User Profile Replication Engine and SPDiag: Local administrator

If you want to install SharePoint Diagnostics Tool (SPDiag), see the "Install SPDiag" section in this topic for specific requirements.

Important Important:

In certain cases, the SharePoint Administration Toolkit must be installed on all servers in a farm in order for specific operations to run successfully. For example, you can create a task to run on any available server. However, unless the SharePoint Administration Toolkit is installed on the server upon which the operation is selected to run, the newly created timer job will fail and the log file at %COMMOMPROGRAMFILES%\Microsoft Shared\web server extensions\12\Logs will contain the following two messages:

  • SharePoint cannot deserialize an object of type Microsoft.Office.Server.ESCM.ESCMStatsCollectionJob, Microsoft.Office.Server.ESCM, Version=12.0.0.0, Culture=neutral, PublicKeyToken=<random token number> on this machine. This typically occurs because the assembly containing this type is not installed on this machine. In this case, this message can be safely ignored. Otherwise, the assembly needs to be installed on this machine in a location that can be discovered by the .NET Framework.

  • SharePoint cannot deserialize an object of type Microsoft.Office.Server.ESCM.ESCMPersistedObject, Microsoft.Office.Server.ESCM, Version=12.0.0.0, Culture=neutral, PublicKeyToken=<random token number> on this machine. This typically occurs because the assembly containing this type is not installed on this machine. In this case, this message can be safely ignored. Otherwise, the assembly needs to be installed on this machine in a location that can be discovered by the .NET Framework.

ImportantImportant:

On a Windows Server 2008-based computer, if you want to run the User Profile Replication Engine tool and User Access Control (UAC) is enabled, you must elevate the permission of the application to Run as Administrator. For additional information about User Access Control, see User Account Control Step-by-Step Guide.

To install the SharePoint Administration Toolkit

  1. From either the SharePoint Administration Toolkit x86 page (http://go.microsoft.com/fwlink/?LinkId=141504) or the SharePoint Administration Toolkit x64 page (http://go.microsoft.com/fwlink/?LinkID=142035), download the MicrosoftSharepointAdministrationToolkit.exe file by clicking the Download button, and then save the file to your hard disk.

  2. Double-click the MicrosoftSharepointAdministrationToolkit.exe program file on your hard disk to start the Setup program.

  3. After the License Terms for Microsoft Software is accepted, click Next.

  4. Select which tool or tools are to be installed by choosing the appropriate icon and select the top-level feature (“This feature will be installed on local hard drive”).

  5. The default install folder location is C:\Program Files\Microsoft\SPAdministrationToolkit. Click Browse to change the location of this folder. After a location is selected, click OK, and then click Next.

  6. To complete installation, click Finish.

The SharePoint Administration Toolkit installer installs the solution files for the Batch Site Manager and the Permission Reporting Tool, but does not deploy these features to the SharePoint farm. After you install the toolkit, you can deploy and activate these features using the following procedures.

To deploy and activate the Batch Site Manager feature

  1. At the command prompt, run stsadm.exe –o addsolution –filename “C:\Program Files\Microsoft\SPAdministrationToolkit\PermissionReporting\BatchSiteManager.wsp” to add the solution file to the farm solution store.

  2. Run stsadm.exe –o deploysolution –name BatchSiteManager.wsp –immediate -allowgacdeployment to deploy the solution to the farm.

  3. Run stsadm.exe –o activatefeature –name BatchSiteManagerLinks to activate the feature.

To deploy and activate the Permission Reporting Tool feature

  1. At the command prompt, run stsadm.exe –o addsolution –filename “C:\Program Files\Microsoft\SPAdministrationToolkit\PermissionReporting\PermissionReporting.wsp” to add the solution file to the farm solution store.

  2. Run stsadm.exe –o deploysolution –name PermissionReporting.wsp –immediate -allowgacdeployment to deploy the solution to the farm.

  3. Run stsadm.exe –o activatefeature –name PermissionReporting to activate the feature.

NoteNote:

When you deploy and activate either the Batch Site Manager or the Permission Reporting Tool features, several timer jobs are started and must be allowed to complete before the features will be available for use. You can monitor the timer job processes in the Job Status/Definition list and Solution Management in the Central Administration console.

Install SPDiag

You can install SPDiag on any computer in the SharePoint farm. To ensure optimum performance, you should install SPDiag on the farm server with the least resource usage. For example, a dedicated Central Administration Web server would be an ideal host.

In order to collect performance counter data, you must install the .NET Framework 3.5 on the SPDiag host computer. To display performance counter data, you will also need to install the Microsoft Chart Controls for the .NET Framework 3.5.

To download the .NET Framework 3.5, see Microsoft .NET Framework 3.5 (http://go.microsoft.com/fwlink/?LinkId=141508).

To download the Microsoft Chart Controls, see Microsoft Chart Controls for Microsoft .NET Framework 3.5 (http://go.microsoft.com/fwlink/?LinkId=141512).

Note Note:

SPDiag can be used in online or offline modes. In online mode, SPDiag is installed on a Web server belonging to the farm you wish to troubleshoot. This allows SPDiag to connect to the farm and collect data. In offline mode, in which SPDiag is installed on a computer that is not a part of a farm, you can use SPDiag to review existing SPDiag projects and, in SPDiag version 2, import log files from a farm, but you cannot collect data directly from a farm.

Caution Caution:

Using SPDiag can consume significant network bandwidth and other resources on the database server used to host the project database. Make sure that both the project database server, and the network between the project database server and the farm, has adequate resources available for running SPDiag.

SPDiag does not consume substantial resources on the host computer.

The default SPDiag installation directory is C:\Program Files\Microsoft\SPAdministrationToolkit\SharePoint Diagnostics.

See Also

Community Content   What is Community Content?
Add new content RSS  Annotations
SharePoint version validation failed      Diman Sharanov   |   Edit   |   Show History
Hi all.
After I've deployed solution and tried to activate feture Security Report I recieved an error:
SharePoint version validation failed. April CU is required to activate Permission Reporting.
I investigate the exception with reflector and found out that on feature ectivation code checks the Microsoft.SharePoint.dll version. and it require that the build part it must not be less than 6504. I checked my Microsoft.SharePoint.dll and see that is a 12.0.6421.1000.
SP2, April CU and June CU are installed on the server.
Have you any suggestions?
Tags What's this?: Add a tag
Flag as ContentBug
Typo      funzel   |   Edit   |   Show History
C:\Program Files\Microsoft\SPAdministrationToolkit\PermissionReporting\BatchSiteManager.wsp is wrong as location of batchsitemanager
Tags What's this?: Add a tag
Flag as ContentBug
Re: SharePoint version validation failed      Hatzi74   |   Edit   |   Show History
Hello Diman,

it looks like you have not installed the April CU correctly. Your Version number indicates that you are still using the SP2 "only". Try reinstalling the April CU and you should have the correct Version to use these tools. Those are the current Version numbers.

6421 Service Pack 2
6504 Cumulative Update April 2009
6510 Cumulative Update June 2009
Tags What's this?: Add a tag
Flag as ContentBug
Content Correction - Paths      Aamir Qureshi   |   Edit   |   Show History

Corrections are in bold.

To deploy and activate the Batch Site Manager feature (step 1)
Incorrect:
stsadm.exe –o addsolution –filename "C:\Program Files\Microsoft\SPAdministrationToolkit\PermissionReporting\BatchSiteManager.wsp"
Correct:
stsadm.exe -o addsolution -filename "C:\Program Files\Microsoft\SPAdministrationToolkit\BatchSiteManagerSolution\BatchSiteManager.wsp"
　
To deploy and activate the Permission Reporting Tool feature (step 1)
Incorrect:
stsadm.exe –o addsolution –filename "C:\Program Files\Microsoft\SPAdministrationToolkit\PermissionReporting\PermissionReporting.wsp"
Correct:
stsadm.exe -o addsolution -filename "C:\Program Files\Microsoft\SPAdministrationToolkit\PermissionReportingSolution\PermissionReporting.wsp"
　
Aamir M Qureshi
http://www.AgileConcepts.com/Blogs/AQ

To deploy and activate SharePoint Administration Toolkit features using the correct paths      Kyle Bateman   |   Edit   |   Show History

For clarification:

Open Command Prompt

Cd C:\Program Files\Common Files\Microsoft Shared\web server extensions\12\BIN

To deploy and activate the Batch Site Manager feature


At the command prompt, run stsadm.exe -o addsolution -filename "C:\Program Files\Microsoft\SPAdministrationToolkit\BatchSiteManagerSolution\BatchSiteManager.wsp"

To deploy and activate the Permission Reporting Tool feature

At the command prompt, run stsadm.exe -o addsolution -filename "C:\Program Files\Microsoft\SPAdministrationToolkit\PermissionReportingSolution\PermissionReporting.wsp"

Now for the final process:

Be sure to deploy both of the solutions via Central Administration: Central Administration > Operations > Solution Management


Kyle Bateman
http://www.binarywave.com/blogs/kbateman/default.aspx

Flag as ContentBug
Windows 2008 Issue?      TheDillon   |   Edit   |   Show History
Installed on Windows 2008 SP2 server, MOSS 2007 (Sp2 with June Update). When I click on Broken Inh Reports, Check Eff Perms, or Compare Permissions, the following shows in the SharePoint logs:

Exception Type: System.Web.HttpException Exception Message: The resource object with key 'StatusPageTitle' was not found.
Exception Type: System.Web.HttpException Exception Message: The resource object with key 'AccountPageTitle' was not found.
Exception Type: System.Web.HttpException Exception Message: The resource object with key 'TreeViewReportPageTitle' was not found.

Any thoughts?

Tags What's this?: Add a tag
Flag as ContentBug
WindowsServer 2008 (R2) and SharePoint Admin Toolkit v4      Aamir Qureshi   |   Edit   |   Show History
Folks -
Admin Tool v4 is not supported on Windows 2008.
On the download page for v4 (x32 and x64) it is Windows 2003 is the mentioned as supported platform (doh!!). May be someone from Admin Tool Team can post a response for furture support on Windows 2008.
Aamir Qureshi
http://www.agileconcepts.com/Blogs/AQ/Lists/Posts/Post.aspx?ID=33
Tags What's this?: 2008 (x) 4.0 (x) admin (x) tool (x) windows (x) Add a tag
Flag as ContentBug
SharePoint Administration Toolkit is supported on Windows Server 2008/Windows Server 2008 R2      Daniel Winter [MSFT]   |   Edit   |   Show History

The download page was missing Windows Server 2008 and Windows Server 2008 R2.

The SharePoint Administration Toolkit is supported on the same operating systems that SharePoint is supported on. We will be updating the download page shortly to reflect this fact.

Help installing on WSS servers      Frank Cardillo   |   Edit   |   Show History
Environment:
windows server 2008
WSS 3.0 sp2 with April CU Version 12.0.0.6504
2 Web servers- 1 db server

Installed farm admin toolkit v4, Added the permissionreporting.wsp deployed and activated.

The links show up correctly but when you try to use the permission reporting you get a general error.

The log shows an error that it is looking for the securityreport.en-US.resx

securityreport.en-US.resx does not exist in the permissionreporting.wsp

This worked fine in my dev environment which is the same except I only have one web server.

Can anyone point me a copy of the securityreport.en-US.resx or tell me how to make it look at the securityreport.resx file which is there?

Thanks
Frank



Solution Error      sdfaffffffffdasdvasdvafcasfdadfd   |   Edit   |   Show History
I have deployed both site manager and permissions reporting wsp and receive and error in solution managment status.
Tags What's this?: Add a tag
Flag as ContentBug
RE Windows 2008 Issue      Tonysi   |   Edit   |   Show History
Hi TheDillon,

If you see the following:

Exception Type: System.Web.HttpException Exception Message: The resource object with key 'StatusPageTitle' was not found.
Exception Type: System.Web.HttpException Exception Message: The resource object with key 'AccountPageTitle' was not found.
Exception Type: System.Web.HttpException Exception Message: The resource object with key 'TreeViewReportPageTitle' was not found.

it's because the securityreport.resx file didn't get pushed down to your web applications. Do the following:

stsadm -o copyappbincontent
iisreset

And you should be good to go. Frank should also try this

Cheers
The installation guide isn't accurate.      Y.J   |   Edit   |   Show History

To deploy and activate the Batch Site Manager feature

  1. At the command prompt, run stsadm.exe -o addsolution -filename "C:\Program Files\Microsoft\SPAdministrationToolkit\BatchSiteManagerSolution\BatchSiteManager.wsp" to add the solution file to the farm solution store.
  2. Run stsadm.exe -o deploysolution -name BatchSiteManager.wsp -immediate -allowgacdeployment to deploy the solution to the farm.
  3. Go to Central Admin -> Operations -> Solution Management, confirm batchsitemanager.wsp status is deployed.
  4. Run stsadm -o activatefeature -name BatchSiteManagerLinks to activate the feature.

To deploy and activate the Permission Reporting Tool feature

  1. At the command prompt, run stsadm.exe -o addsolution -filename "C:\Program Files\Microsoft\SPAdministrationToolkit\PermissionReportingSolution\PermissionReporting.wsp" to add the solution file to the farm solution store.
  2. Run stsadm.exe -o deploysolution -name PermissionReporting.wsp -immediate -allowgacdeployment to deploy the solution to the farm.
  3. Go to Central Admin -> Operations -> Solution Management, confirm permissionreporting.wsp status is deployed.
  4. Run stsadm -o activatefeature -name PermissionReporting to activate the feature.

http://nitman.com Tips from real life!

© 2009 Microsoft Corporation. All rights reserved. Terms of Use | Trademarks | Privacy Statement
Page view tracker