ASPAlliance ASP Kitchen  
Search: Go  

ASP Kitchen: Classic ASP Articles: More about Searching Index Server With ASP

More about Searching Index Server With ASP

Introduction

A previous article in the ASP Kitchen demonstrated how ASP could be used to create a web front-end to Index Server. While the search results page demonstrated in the article contained most of what is needed to create a results page, its formatting of the search results was pretty basic, as can be seen below:

Output from SearchResults.asp

Contrast this with the search results page from my personal website below. This demonstrates what sort of formatting can be applied to the search results. If you want to see this page in action, try the search facility on my personal website.

Output from an improved SearchResults.asp - as taken from my personal website

Improving the display of column properties

As was described in the previous article, each search result contains a number of column properties. These contain information about each search result. In the previous article, the properties used were: FileName, doctitle, Size, Create and Characterization. As will be described below, each of these can be used to provide useful information in search results pages.

Hyperlinking the search result's filename

The FileName column property contains the search result's filename (e.g. default.htm). However, a more useful column property is vpath, which also contains the file's path as well as its filename (e.g. /financial/reports/june2002/default.htm). Once the file's path is know, it is straightforward to hyperlink the search result's URL using something like the following:

Const SERVER_URL = "http://www.brettb.com"
Response.write "<b>URL:</b> <a href=""" & SERVER_URL & oRS("vpath") & """>" & SERVER_URL & oRS("vpath") & "</a><br>"

A common convention when presenting search results is to hyperlink the document's name to its URL. Index Server uses the doctitle column property to store the document's name):

Const SERVER_URL = "http://www.brettb.com"
Response.write "<b>URL:</b> <a href=""" & SERVER_URL & oRS("vpath") & """>" & oRS("doctitle") & "</a><br>"

Displaying the search result's file size

The Size column property contains the size of the file in bytes. A small formula can be used to display the file's size in Kilobytes, which is often a better unit of measure for file sizes:

Response.write "<b>Size:</b> " & Round(CInt(oRS("Size"))/1024, 1) & "K <br>"

Displaying the document creation and modification dates

The creation and modification date and time for files are contained within the Create and Write column properties, respectively. These can be formatted to display a more user friendly date by use of the FormatDateTime VBScript function as shown below:

Response.write "<b>Create:</b> " & FormatDateTime(oRS("Create"), 1) & "<br>"
Response.write "<b>Write:</b> " & FormatDateTime(oRS("Write"), 1) & "<br>"

Further document properties

A number of other document properties may be of interest, such as HitCount (the number of words matching the query that were found in the file), and Rank (how closely the file matched the query). A more detailed description of the Rank column property is in the following section.

A complete listing of column properties is available here (it is also available in the IIS 4.0 documentation). Many properties are only of relevence if Microsoft Office documents are being indexed. Remember that if you wish to use any additional columns then they must be listed in the Columns property of the Index Server Query COM component, e.g.

oQuery.Columns = "DocAuthor, vpath, doctitle, FileName, Path, Write, Size, Rank, Create, Characterization, HitCount"

Displaying a file's rank

The Rank column property is used as a measure of how closely a document returned by Index Server matched the search query. Rank ranges between 0 and 1000, with 1000 being the closest match. The calculation of rank is fairly complex, but a good explanation is available. To summarise, rank depends on the number of times the query terms appear in the document, as well as the number of times the query terms appear in the Index Server catalog.

Information

Strange but true!

Oddly enough, the presentation of rankings in search results seems to be a thing of the past for most of the major search engines. Neither Google, Excite, Lycos or AltaVista display rankings. Is this evidence of the "dumbing down" of the web, or are rankings unnecessary screen clutter? Incidentally, Northern Light still display rankings in search results!

In the search catalog on my own personal site, searches for "ASP" will return results with a low rank, because that word appears frequently (since I am an ASP developer and have lots of pages about ASP). By contrast, searches for "tomato" will return a high rank for the page about my biotechnology career, since it is the only page to contain numerous references to tomatoes.

In a search results page, rank can be displayed as a percentage by simply dividing the Rank by 10:

Response.write "<b>Rank:</b> " & CInt(oRS("Rank")/10) & "%<br>"

Alternatively, it can be displayed graphically. There are a number of ways of achieving this. On my personal search page, the results are accompanied by a graphic showing from 0 to 10 filled bars, according to the rank. So a document matching with a ranking of between 700 and 800 will get 8 bars, and therefore an 80% ranking. Obviously the number of filled bars can only give an approximate ranking, but it is there as a visual aid so an accurate ranking is not important.

If you want to use the method I use, the code is below. The code should of course be executed for each page in the search results.

iCurrentRanking = oRS("Rank") 'Retrieve the search ranking for this particular search result

If iCurrentRanking > 900 Then
    iRanking = 10
ElseIf iCurrentRanking > 800 Then
    iRanking = 9
ElseIf iCurrentRanking > 700 Then
    iRanking = 8
ElseIf iCurrentRanking > 600 Then
    iRanking = 7
ElseIf iCurrentRanking > 500 Then
    iRanking = 6
ElseIf iCurrentRanking > 400 Then
    iRanking = 5
ElseIf iCurrentRanking > 300 Then
    iRanking = 4
ElseIf iCurrentRanking > 200 Then
    iRanking = 3
ElseIf iCurrentRanking > 100 Then
    iRanking = 2
Else
    iRanking = 1
End If


sCurrentRankingAltTag = (iRanking * 10) & " percent match" 'Create an ALT tag for the ranking image

The appropriate rank image is then inserted using the following ASP:

<img src="images/<%=iRanking%>bars.png" alt="<%=sCurrentRankingAltTag%>" width="80" height="17">

Note that the images are in the images sub-folder, and are named from 1bars.png to 10bars.png. Examples are shown below:

1bars.png, representing 10% match
1bars.png

4bars.png, representing 40% match
4bars.png

8bars.png, representing 80% match
8bars.png

10bars.png, representing 100% match
10bars.png

Futher Index Server goodies

Need to figure out how to do other things with Index Server? to me and I'll add them to the Index Server section of the ASP Kitchen!

Code samples and working ASP pages

  • Fully working versions of the search form and results pages described in this article may be accessed from my personal website.

Further reading

  • Index Server Companion. The Index Server Companion allows Index Server to index content from remote websites and ODBC databases. Site Server 3.0 Search is not required!

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 the popular NDoc code documentor.
   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).

WAPT Website Application Load, Stress and Performance Testing Software
WAPT is a useful software tool for the automated testing of website performance under various load and stress scenarios.
   Website Application Load, Stress and Performance Testing Software review Read WAPT Review.
   Download Trial Version of WAPT Download Trial Version

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

"More about Searching Index Server With ASP" published on ASPAlliance.com on 4 October 2001.

ASP Kitchen: Classic ASP Articles: More about Searching Index Server With ASP

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 - 2009.