Microsoft(R) Office SharePoint(TM) Portal Server 2003 - 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
FILTDUMP.EXE
GTHRLOG.VBS
LRTEST.EXE
PLEX.EXE
SPSINDEXBACKUPVERIFIER.EXE
TIFF_OCR_ON.REG
NOTE: User input is indicated by angle brackets (for example, <path>, <index name>, and so on).
==============================
CATUTIL.EXE
==============================
Use this tool to list site IDs for all portal sites, move content indexes, move property store files, and delete indexes.
To use catutil.exe, copy it from the SharePoint Portal Server CD to your server.
IMPORTANT: Do not start the Microsoft SharePointPS Search service (SharePointPSSearch) 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.
------------------------------
Listing Site IDs
------------------------------
SharePoint Portal Server provides a utility named catutil.exe that you can use to list all portal sites and their associated internal site IDs.
Each portal site created by SharePoint Portal Server has an internal site ID [a globally unique identifier (GUID)]. Performing functions such as moving or deleting indexes requires the site ID.
To list portal sites and their internal site IDs, type catutil.exe listsites
For each portal site, the URL and internal ID are displayed.
------------------------------
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 stores the property store and related log files in the \Data\<GUID> folder, where <GUID> is a standard Windows GUID in the form of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. By default, the Data directory is located under %ProgramFiles%\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 SharePointPSSearch.
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 <internal site ID> -m "<path>\sps.edb" 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 <internal site ID> -m "D:\Store\sps.edb"
Note that you can change the name of the .edb file from sps.edb to something else. For example, you can type catutil PROPSTORE <internal site ID> -m "D:\Store\MyFileName.edb"
6. Start SharePointPSSearch.
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:\). SharePointPSSearch 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 SharePointPSSearch.
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 <internal site ID> -L "<path>" 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 <internal site ID> -l "E:\Logs"
6. Start SharePointPSSearch.
------------------------------
Moving Content Index Files
------------------------------
SharePoint Portal Server provides a utility named catutil.exe that you can use to move content index files. If the location where the index (Search index) files 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 in the \Data\Applications\<GUID>\Projects folder, where <GUID> is a standard Windows GUID in the form of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. By default, the Data directory is located under %ProgramFiles%\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 portal site, 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 portal sites, SharePoint Portal Server creates the new indexes 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, you can specify a new path for the index files before you create the portal site. Then, when you create the new portal site, the index file and any propagated indexes are stored in the new location.
--If the location where the index files are stored 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 SharePointPSSearch.
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 <internal site ID> <index name> "<path>" [/c] and then press ENTER.
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 SharePointPSSearch.
------------------------------
Deleting a Content Index
------------------------------
SharePoint Portal Server provides a utility named catutil.exe that you can use to delete index files.
WARNING: Using catutil.exe to delete a default content index (Portal_Content or Non_Portal_Content) will cause failures throughout the portal site. You should not delete Portal_Content or Non_Portal_Content.
To delete an index:
1. Stop SharePointPSSearch.
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 <internal site ID> <index name> [http://<server name>] and then press ENTER.
The optional parameter [http://<server name>] is required if you are deleting a propagated index from the search server.
6. Start SharePointPSSearch.
==============================
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\SharePoint Portal Server\Bin on the operating system drive of your server.
Open command prompt, navigate to Program Files\SharePoint Portal Server\Bin, and type filtdump <path to file>\<filename>
Available switches:
-b Results without header information
-m MIME type string
-o Unicode output file
==============================
GTHRLOG.VBS
==============================
Use this Visual Basic script file to view the gatherer log. This script file connects to a database stored in Microsoft SQL Server and pulls the logging information from the tables. You can also view the log from the View Gatherer Log Summary or the Gatherer Log Details page in the portal site. Gthrlog.vbs is in the Support\Tools directory on the SharePoint Portal Server CD.
Administrators might want to back up old versions of the gatherer log for statistical purposes or trend analysis.
To view the gatherer log files:
1. Copy gthrlog.vbs to your server.
2. Open command prompt.
3. Navigate to the location of gthrlog.vbs.
4. Type cscript //h:cscript and then press ENTER.
5. For information about the usage of gthrlog.vbs, type gthrlog.vbs
==============================
LRTEST.EXE
==============================
The Language Resource Test Tool allows the loading of word breakers, stemmers, and filters so that the user can see the output of these resources given specific input. This is helpful for:
--Word breakers and stemmers when identifying how text is broken at index time, query time, and query time with stemming.
--Filters to view exactly what the output is from a given filter.
To obtain help for using this tool, type lrtest ? at command prompt.
Additional information about this feature will be provided on the Web. For the latest information, see http://www.microsoft.com/SharePoint/Assistance.
==============================
PLEX.EXE
==============================
Use this tool for document libraries (Web Storage System-based) 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 view SharePoint Portal Server document properties by using Plex.exe:
1. Double-click Plex.exe.
2. In Folder, type http://<server name>/<document library name>
For example, to view the schema of the Marketing document library on SharePoint Portal Server computer Market1, type http://Market1/Marketing
3. Click Refresh. The folders for the document library are displayed.
4. Select a folder. The schema elements (properties) and values are displayed.
Note that not all properties displayed are retrievable properties.
==============================
SPSINDEXBACKUPVERIFIER.EXE
==============================
Additional information about this feature will be provided on the Web. For the latest information, see http://www.microsoft.com/SharePoint/Assistance.
==============================
TIFF_OCR_ON.REG
==============================
You can enable optical character recognition (OCR) when crawling TIFF files.
Enable OCR by double-clicking tiff_ocr_on.reg in the Support\Tools directory on the SharePoint Portal Server CD.