Microsoft KB Archive/318468

= Contents of the Support Tools ToolsHowTo.txt File =

Article ID: 318468

Article Last Modified on 2/28/2007

-

APPLIES TO


 * Microsoft SharePoint Portal Server 2001

-



This article was previously published under Q318468



SUMMARY
This article contains the complete text of the ToolsHowTo.txt file that is located in the following folder on the SharePoint Portal Server 2001 CD-ROM, where  is the drive letter that is assigned to your CD-ROM or DVD-ROM drive:





MORE INFORMATION
Microsoft(R) SharePoint(TM) Portal Server 2001 - Unsupported Tools

These tools are UNSUPPORTED and are provided in their current form without warranty of any kind.

The following UNSUPPORTED tools are included in the Support\Tools directory on the SharePoint Portal Server CD:

- CATUTIL.EXE Use this tool to move indexes, move property store files, delete indexes, and specify the primary server dedicated to crawling shortcuts on the server dedicated to searching. Procedures are provided later in this document.

- FILTDUMP.EXE Use this tool to view the appearance of a document when it is filtered. The tool only works for files (that is, it does not work for URLs). To use filtdump.exe, copy it from the SharePoint Portal Server CD to Program Files\Common Files\Microsoft Shared\MSSearch\Bin on the operating system drive of your server.

- GTHRLOG.VBS Use this Visual Basic script file to view the gatherer log. Procedures are provided later in this document.

- PLEX.EXE Use this tool to view document properties in the Web Storage System. Procedures are provided later in this document.

- SECDESC_TOOL.EXE Use this tool to dump access control lists (ACLs) and role memberships of specified resources (folders or files). This tool functions only for the Microsoft Web Storage System. To use this tool, copy it from the SharePoint Portal Server CD to the server \Bin directory. The location of this directory depends on where you installed the program files for SharePoint Portal Server. For example, if you installed SharePoint Portal Server on drive D under Program Files\SharePoint Portal Server, the location of this directory is D:\Program Files\SharePoint Portal Server\Bin.

- SRCHADM.VBS Use this tool to perform administrative functions for Search. To use this tool, copy it from the SharePoint Portal Server CD to the server \Bin directory. The location of this directory depends on where you installed the program files for SharePoint Portal Server. For example, if you installed SharePoint Portal Server on drive D under Program Files\SharePoint Portal Server, the location of this directory is D:\Program Files\SharePoint Portal Server\Bin.

Type cscript //h:cscript and then press ENTER to set cscript as the default script host before using this tool.

-

NOTE: User input is indicated by angle brackets (for example,, , and so on).

=
==== USING CATUTIL.EXE

=
====

To use catutil.exe, copy it from the SharePoint Portal Server CD to your server.

IMPORTANT: Do not start the Microsoft Search (MSSearch) service while catutil.exe is running.

NOTE: Catutil.exe has an integrity checker function. This is not the same as the Isinteg.exe utility that shipped with Exchange Server 5.5. Do NOT use Isinteg.exe against the SharePoint Portal Server property store.

--- Moving Property Store Files --- SharePoint Portal Server provides a utility named catutil.exe that you can use to move property store files and to change the location of the log files for the property store. Property store files contain the metadata from documents. SharePoint Portal Server shares these files across all workspaces on a single server.

SharePoint Portal Server stores the property store and related log files in the \Data\FTData\SharePointPortalServer directory. By default, the Data directory is located under Program Files\SharePoint Portal Server. The Data directory is located elsewhere if you chose to install the data files elsewhere during the server installation process.

For high performance, the property store and related log files must be on separate dedicated physical volumes. You cannot move property store files by using SharePoint Portal Server Administration. You must use catutil.exe to move property store files and to change the location of log files for the property store.

To move the property store file to a new location:

1. Stop MSSearch. 2. On the taskbar, click Start, point to Programs, point to Accessories, and then click Command Prompt. 3. Change to the directory containing catutil.exe. 4. Type catutil PROPSTORE and then press ENTER. A usage description displays. 5. Type catutil PROPSTORE SharePointPortalServer -m &quot; \sps.edb&quot; and then press ENTER. For example, if you want to move the property store to a directory named Store on drive D, you would type catutil PROPSTORE SharePointPortalServer -m &quot;D:\Store\sps.edb&quot; Note that you can change the name of the .edb file from sps.edb to something else. For example, you can type catutil PROPSTORE SharePointPortalServer -m &quot;D:\Store\MyFileName.edb&quot; 6. Start MSSearch.

IMPORTANT: Do not change the location of the log files of the property store to the root of a directory (for example, do not change the location to D:\). MSSearch does not function properly if the files are located on a directory root. If you have changed the location to a directory root and search no longer functions, change the location of the files to a subdirectory (for example, change the location to D:\LogFiles).

To move the log files to a new location:

1. Stop MSSearch. 2. On the taskbar, click Start, point to Programs, point to Accessories, and then click Command Prompt. 3. Change to the directory containing catutil.exe. 4. Type catutil PROPSTORE and then press ENTER. A usage description displays. 5. Type catutil PROPSTORE SharePointPortalServer -l &quot; &quot; and then press ENTER. For example, if the property store file is on drive D, you may want to change the location of the property store log files to a directory named Logs on drive E to improve performance. You would type catutil PROPSTORE SharePointPortalServer -l &quot;E:\Logs&quot; 6. Start MSSearch.

-- Moving Index Files -- SharePoint Portal Server provides a utility named catutil.exe that you can use to move index files. If the location where the index (Search index) files for a workspace are stored has no remaining disk space, you can use catutil.exe to move the existing index files to another location (partition or hard disk).

SharePoint Portal Server stores the index files for a workspace in the \Data\FTData\SharePointPortalServer\Projects directory. By default, the Data directory is located under Program Files\SharePoint Portal Server. The Data directory is located elsewhere if you chose to install the data files elsewhere during the server installation process.

When you create a workspace, SharePoint Portal Server creates an index under this directory. SharePoint Portal Server also creates all indexes propagated to the server under this root node. You can use SharePoint Portal Server Administration to change this path. When you change this path, the existing indexes do not move to the new index location. However, if you create additional workspaces, SharePoint Portal Server creates the new indexes for the workspaces in the new location. If you want to move existing indexes to a new location, you must use catutil.exe.

You cannot use MOVECAT to move propagated indexes on the server dedicated to searching.

To summarize:

--If you are planning disk space usage for a new workspace, you can use SharePoint Portal Server Administration to specify a new path for the index files before you create the workspace. Then, when you create the new workspace, the index file and any propagated indexes are stored in the new location. --If the location where the index files are stored for existing workspaces has a small amount of disk space remaining, you can use catutil.exe to move the existing files to a new location.

To move the index files to a new location:

1. Stop MSSearch. 2. On the taskbar, click Start, point to Programs, point to Accessories, and then click Command Prompt. 3. Change to the directory containing catutil.exe. 4. Type catutil MOVECAT and then press ENTER. A usage description displays. 5. Type catutil MOVECAT SharePointPortalServer &quot; &quot; [/c] and then press ENTER. The index name is the name of the workspace. For example, if you want to move the index for a workspace named Adventure to a directory named Index on drive D, you would type catutil MOVECAT SharePointPortalServer Adventure &quot;D:\Index&quot; The optional parameter /c checks if the move will succeed but does not move the files. You must type the string without the /c to move the files. 6. If you want to move the index file, type Y and then press ENTER. 7. Start MSSearch.

- Deleting an Index - SharePoint Portal Server provides a utility named catutil.exe that you can use to delete index files. For example, if you have deleted an index workspace from the server dedicated to indexing but the propagated index remains on the server dedicated to searching, you can use DELETECAT to delete the propagated index. SharePoint Portal Server usually deletes the propagated index when you delete the index workspace. However, if the destination workspace is unavailable at the time you delete the index workspace, you must use DELETECAT to delete the propagated index.

To delete an index:

1. Stop MSSearch. 2. On the taskbar, click Start, point to Programs, point to Accessories, and then click Command Prompt. 3. Change to the directory containing catutil.exe. 4. Type catutil DELETECAT and then press ENTER. A usage description displays. 5. Type catutil DELETECAT SharePointPortalServer [http:// / ] and then press ENTER. The index name is the name of the workspace. The optional parameter [http:// / ] is required if you are deleting a propagated index from the server dedicated to searching. The server name is the name of the server dedicated to searching, and the workspace name is the name of the workspace on that server. 6. Start MSSearch.

-- Changing the Index Workspace that Crawls Shortcuts -- The Content Sources folder in each index workspace has one additional content source. This content source is called Portal Shortcuts. It is dedicated to crawling any shortcuts on the destination server. Shortcuts in a workspace on a server dedicated to searching (the destination server) may point to content located outside the workspace.

Only the first index workspace that propagates to the destination workspace actually crawls the shortcuts. Any other index workspaces that propagate to the destination workspace report errors in the gatherer log. The error indicates which index workspace crawls the shortcuts.

If you have propagated indexes to this workspace from one or more servers dedicated to indexing, you can use catutil.exe to specify which server crawls these shortcuts on the server dedicated to searching.

IMPORTANT: You run the following procedure on the server dedicated to searching.

To change the index workspace that crawls shortcuts:

1. Stop MSSearch. 2. On the taskbar, click Start, point to Programs, point to Accessories, and then click Command Prompt. 3. Change to the directory containing catutil.exe. 4. Type catutil SETPRIMARYDCI and then press ENTER. A usage description displays. 5. Type catutil SETPRIMARYDCI SharePointPortalServer  http:// / and then press ENTER. The index workspace name is the name of the index workspace on the server dedicated to indexing. The server name is the name of the server dedicated to searching, and the workspace name is the name of the workspace on that server. 6. Start MSSearch.

=
==== USING GTHRLOG.VBS

=
====

You can view the gatherer log by using a Visual Basic script file or from the ASP page in the workspace. Gthrlog.vbs is in the Support\Tools directory on the SharePoint Portal Server CD. Copy gthrlog.vbs to your server.

Administrators might want to back up old versions of the gatherer log for statistical purposes or trend analysis.

By default, SharePoint Portal Server deletes the log after five days. Administrators can specify per-workspace settings for the gatherer log files. If you want to view the most recent log file, select the file with the largest number in the file name. For example, workspacename.2.gthr is more recent than workspacename.1.gthr.

To view the gatherer log files:

1. On the taskbar, click Start, point to Programs, point to Accessories, and then click Command Prompt. 2. Type cscript //h:cscript and then press ENTER. 3. Type &quot; \gthrlog.vbs&quot; &quot; \ .gthr&quot; and then press ENTER. The quotation marks are only required if the path contains spaces. For example, if gthrlog.vbs is on D:\Program Files\Common Files \Microsoft Shared\MSSearch\Bin, and the log file Adventure.2.gthr for the workspace named Adventure is on D:\Program Files\SharePoint Portal Server\Data\FTData\SharePointPortalServer\GatherLogs\Adventure, type &quot;D:\Program Files\Common Files\Microsoft Shared\MSSearch\Bin \gthrlog.vbs&quot; &quot;D:\Program Files\SharePoint Portal Server\Data\FTData\ SharePointPortalServer\GatherLogs\Adventure\Adventure.2.gthr&quot; and then press ENTER. In this case, the quotation marks are required because of the spaces in the directory names.

=
= USING PLEX.EXE

=
=

Use this tool to view document properties in the Web Storage System. Plex.exe is in the Support\Tools directory on the SharePoint Portal Server CD. You can also copy Plex.exe to your server.

To use Plex.exe, you must register the file MSCOMCTL.OCX on your computer. This file is included in the Support\Tools directory on the SharePoint Portal Server CD.

To view SharePoint Portal Server document properties by using Plex.exe:

1. Double-click Plex.exe. 2. In Folder, type http:// / For example, to view the schema of the Marketing workspace on SharePoint Portal Server computer Market1, type http://Market1/Marketing 3. Click Refresh. The folders for the workspace are displayed. 4. Select a folder. The schema elements (properties) and values are displayed.

Note that not all properties displayed are retrievable properties. For information about retrievable properties, see Microsoft SharePoint Portal Server Software Development Kit.

Additional query words: SPS share point

Keywords: kbinfo KB318468

-

[mailto:TECHNET@MICROSOFT.COM Send feedback to Microsoft]

© Microsoft Corporation. All rights reserved.