Installing SharePoint Administration Toolkit (Windows SharePoint Services)

  • Article

Applies To: Windows SharePoint Services 3.0

 

Topic Last Modified: 2009-08-25

System Requirements

The SharePoint Administration Toolkit requires 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 (Windows SharePoint Services).

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

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

    • SPDiag: Local administrator

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

Note

The User Profile Replication Engine is not supported for Windows SharePoint Services 3.0.

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.

To install the SharePoint Administration Toolkit

  1. From either the SharePoint Administration Toolkit x86 page (https://go.microsoft.com/fwlink/?LinkId=141504) or the SharePoint Administration Toolkit x64 page (https://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.

Note

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 (https://go.microsoft.com/fwlink/?LinkId=141508).

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

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.

Warning

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

Concepts

Uninstalling SharePoint Administration Toolkit (Windows SharePoint Services)
MSI switches and arguments (Windows SharePoint Services)