ASPAlliance ASP Kitchen  
Search: Go  

Using ASP to View Site Server Search Catalog Properties

Introduction

The Search facility of Site Server 3.0 is invaluable for adding search facilities to your website, especially when your content is spread over multiple websites. But the problem of indexing multiple websites is that it can be difficult to keep track of how large the catalogs are growing. This is a particular problem if you are not responsible for the content on the websites you are indexing.

Obtaining Site Server Search Catalog Properties

The following short script will make it easy to have an at a glance look at the properties of your search catalogs. The script connects to the Search server, and extracts property information for each of the catalogs on that Search server.

The script has several parts. The first part creates a Search administration object. Note that because I like my date and formats to be in UK English format (DD/MM/YY HH:MM:SS) rather than US format (MM/DD/YY HH:MM:SS PM), the session’s locale identifier (LCID) is set to 2057 (0809 Hex). If you are based in the US, this line can be commented out.

<%
session.LCID = 2057
' Set locale ID to UK English

Set searchhost = Server.CreateObject("Search.SearchAdmin.1")

Set searchserver = searchhost.SearchServer
Set searchservercatalogs = searchserver.SearchCatalogs
%>

The following code creates a table with four columns for catalog properties: Catalog name, Date of last update, Number of documents and Size (Mb). Catalog properties are enumerated using a standard For…Each loop. There are several other catalog properties that can be obtained using this type of script, but I have chosen the most useful ones.

<div align="center"><center>

<table border="0" cellpadding="2" width="75%" cellspacing="0">
<tr>
<td width="25%" style="background-color: rgb(132,132,255); border: 1px groove rgb(0,0,0)"><strong>Catalog
name</strong></td>
<td width="25%"
style="background-color: rgb(132,132,255); border-left: 1px none rgb(0,0,0); border-right: 1px groove rgb(0,0,0); border-top: 1px groove rgb(0,0,0); border-bottom: 1px groove rgb(0,0,0)"><strong>Date
of last update</strong></td>
<td width="25%"
style="background-color: rgb(132,132,255); border-left: 1px none rgb(0,0,0); border-right: 1px groove rgb(0,0,0); border-top: 1px groove rgb(0,0,0); border-bottom: 1px groove rgb(0,0,0)"><strong>Number
of documents</strong></td>
<td width="25%"
style="background-color: rgb(132,132,255); border-left: 1px none rgb(0,0,0); border-right: 1px groove rgb(0,0,0); border-top: 1px groove rgb(0,0,0); border-bottom: 1px groove rgb(0,0,0)"><strong >Size
(Mb)</strong></td>
</tr>
<%For Each catalog in searchservercatalogs
Set catalogprops = catalog.Properties
%>
<tr>
<td width="25%" style="background-color: rgb(223,223,255)"><%=catalog.Name%>
</td>
<td width="25%" style="background-color: rgb(223,223,255)"><%=catalogprops.BuildDate%>
</td>
<td width="25%" style="background-color: rgb(223,223,255)"><%=catalogprops.NumberOfDocuments%>
</td>
<td width="25%" style="background-color: rgb(223,223,255)"><%=catalogprops.IndexSize%>
</td>
</tr>
<%Next%>
</table>
</center></div>

Finally, the objects that have previously have been created are tidied up:

<%
Set searchservercatalogs = nothing
Set searchserver = nothing
Set searchhost = nothing
%>

And that’s it. This script will be very useful for having an at a glance inspection of your Search Server’s health. The resulting web page should look something like this:

Sample output from the script described on this page

This script will, therefore, allow you to watch for the following:

  • Problems with catalogs will sometimes result in the catalog containing zero documents.
  • Problems with the Windows NT Task Scheduler will often result in the catalog(s) not being updated at the required date and time.
  • When indexing third party websites you have to be careful that the size of the index doesn’t grow so large that the Search server is overwhelmed.
  • Sudden surges in the number of documents being indexed on the server are usually cause for concern (and hence further investigation).

Further reading

If you want to delve further into remote administration of Site Server, then the comprehensive Software Developer’s Kit is useful (the kit is also on the Site Server 3.0 CD-ROM). Further uses for this script include writing a Windows Scripting Host or Perl script that will periodically record the number of documents in each Search catalog over time. This is useful in recording the growth of your website(s).

  • Index Server Companion. The Index Server Companion allows Index Server to index content from remote websites and ODBC databases. A much cheaper alternative to Site Server 3.0 Search!

You might also like to invest in one of these featured books:

Beginning Site Server 3.0  Professional Site Server 3.0

Useful Development Tools

ASP Documentation Tool™
Automatically creates technical documentation for ASP 2.0 and 3.0 web applications written in VBScript and JScript. Documentation for Microsoft Access, SQL Server 7/2000 databases and Visual Basic 6.0 components associated with the web application can also be incorporated into the reports. Documentation is created in HTML, HTML Help and plain text formats.
   View Sample Output (HTML Help format) View Sample Output (HTML Help format).
   View Sample Output (HTML Format) View Sample Output (HTML Format).
   Download Trial Version Download Trial Version (5.2Mb ZIP file).

.NET Documentation Tool
Automatically creates technical documentation for .NET Framework applications written in C# or VB.NET (including ASP.NET). Documentation for SQL Server 7/2000/2005 databases and C#/VB.NET components associated with the web application can also be incorporated into the reports. Documentation is created in HTML, HTML Help and plain text formats. Additional support for ASP.NET web applications. A useful alternative to NDoc!
   View Sample Output (HTML Help format) View Sample Output (HTML Help format).
   View Sample Output (HTML Format) View Sample Output (HTML Format).
   Download Trial Version Download Trial Version (3Mb ZIP file).

SQL Documentation Tool
The SQL Documentation Tool creates technical documentation for Microsoft SQL Server 7.0, 2000 and 2005 databases. Technical documentation is created in HTML and HTML Help formats. The HTML Help format documentation is fully searchable and cross referenced. The SQL Documentation Tool documents SQL Server Tables, Views, Stored Procedures, Triggers, Table Relationships, Jobs and DTS Packages.
   View Sample Output (HTML Help format) View Sample Output (HTML Help format).
   View Sample Output (HTML Format) View Sample Output (HTML Format).
   Download Trial Version Download Trial Version (10.3Mb ZIP file).

VB Documentation Tool
The VB Documentation Tool creates technical documentation for Microsoft Visual Basic 6.0 projects. Technical documentation is created in HTML and HTML Help formats. The HTML Help format documentation is fully searchable and cross referenced.
   View Sample Output (HTML Help format) View Sample Output (HTML Help format).
   View Sample Output (HTML Format) View Sample Output (HTML Format).
   Download Trial Version Download Trial Version (1Mb ZIP file).

The Website Utility
The Website Utility examines websites for errors and areas that need to be optimised for search engines by using a built in web crawling engine. Errors checked for include broken or moved hyperlinks, missing page titles and missing meta tags. It also generates HTML for use in creating website site maps (table of contents pages - like this one), and is able to create both client-side JavaScript search engines and server-side ASP search engines and ASP.NET search engines for a website.
   View Sample Output (HTML Format) View Sample Output (HTML Format).
   Download Trial Version Download Trial Version (3Mb ZIP file).

Text Workbench
Text Workbench is a file search and replacement utility for text files and Microsoft Office documents. Make rapid file replacements on multiple files and folders full of files. Advanced replacement options include regular expressions support. It even works on remote file systems via FTP. A Regular Expression Laboratory allows advanced pattern matching and replacement expressions to be built and tested. This great utility will make your everyday development tasks much easier!
   Download Trial Version of Text Workbench Download Trial Version (3Mb ZIP file; you have the option to either install directly from this link or save the file for later installation).

Indexing Service Companion
The Indexing Service Companion is a utility that extends the functionality of the Microsoft Windows Indexing Service so that it is able to index content from any remote website and also from ODBC compliant databases. As such it can be used as a low cost alternative to Sharepoint's Search Services.
   View Product Documentation View Product Documentation (119K ZIP file).
   Try Sample Search Facility Try Sample Search Facility.
   Download Trial Version Download Trial Version (1.7Mb ZIP file).

ASP Spell Check
ASPSpellCheck is the easy way to add spell checking capabilities to your ASP or ASP.NET websites, Intranets and web applications. The utility allows you to add spell checking capabilities to any HTML text field or rich content editing text box. It works with all common web browsers, and there are no components or databases to install on the server.
   Read a review of the ASP Spell Check server component Read ASPSpellCheck Review.
   View Examples of the ASPSpellCheck component for adding spell checking capabilities to ASP web applications View ASPSpellCheck Examples.
   Download Trial Version of ASPSpellCheck Download Trial Version (3Mb ZIP file; you have the option to either install directly from this link or save the file for later installation).

Author details

Brett Burridge has worked as a web developer since 1997 and has developed web applications for a range of corporations, start up busiensses and educational establishments.

Brett is presently employed as an Internet developer and technical writer through his own company, Winnersh Triangle Web Solutions Limited. The company produces a number of innovative products, including a range of software documentation tools, which include the ASP Documentation Tool™, the .NET Documentation Tool for VB.NET and C#, and the SQL Server Documentation Tool. Other products include The Website Utility, which functions as a website error checker, search engine optimizer and ASP/ASP.NET search engine builder application.

As well as the ASPAlliance, Brett has written articles for Ariadne.ac.uk, ASPToday, the software documentation portal www.softwaredocumentation.info, and has contributed recipes to the ASP.NET Developer's Cookbook.    links

Outside web development, Brett is interested in travelling (here are my travel logs from New York, Hong Kong and Tokyo), digital photography (here's my photo gallery), tropical fishkeeping and collecting contemporary works of art by artists such as Doug Hyde.

Contact Brett by emailing

Indexing Service Companion - allows the Windows Indexing Service to index content from remote websites and ODBC databases!!!

Article history

"Using ASP to view Site Server Search catalog properties" originally published on ASPWatch.com on October 16 1999. Republished on ASPAlliance.com on 28 September 2001.

ASP Kitchen: ASPWatch.com articles: ASP and Site Server Search

Documentation tools to automate the documentation of SQL Server databases and ASP, C#, VB.NET and VB 6.0 application source code

Download a Free ASP Documentation Tool Now!

Google

Search Engine Builder - Build a search engine for your website!

© page content copyright Brett Burridge 1998 - 2008.