SharePoint Search Bench

UPDATED WIKI: Home

kindohm — Thu, 13 Mar 2008 03:44:32 GMT

Version 1.1.0.0 has been released!

Visit the Releases tab for details.
known bug - by default, the app sets the Start Row equal to "1". For searches that only have one relevant result, this will cause no results to be returned. Until the next release, be sure to explicitly change the Start Row to "0" to get expected results.

Project Description

SharePoint Search Bench has two parts: 1) a desktop app for executing searches in a Microsoft Office Search Server (MOSS) environment and 2) a .NET class library API for executing searches programmatically. The desktop app is a great way to quickly debug and experiement with MOSS search. Use it to debug scopes or to test custom Full Text queries. The API library is great for developers who want an EASY way to search against MOSS.

System Requirements

Microsoft Office SharePoint Server (MOSS). WSS only is not enough!
.NET 3.5 (for running the desktop application)

Aids and References

SharePoint Search Bench API Guide
Example Full Text SQL queries
Writing SQL Syntax Queries for Relevant Results in Enterprise Search: http://msdn2.microsoft.com/en-us/library/bb219479.aspx
QueryPacket / Schema for Enterprise Search (search web service): http://msdn2.microsoft.com/en-us/library/ms563775.aspx

CREATED ISSUE: Default start row set to 1 instead of 0

kindohm — Thu, 13 Mar 2008 03:42:25 GMT

Start row is a zero-based index and needs to default to zero. When a relevant result set returns one record, a start row of 1 will result in zero rows returned.

Source code checked in

kindohm — Thu, 13 Mar 2008 02:59:54 GMT

Added SharePointSearchBench.UI project - highly untested and incomplete. It's the beginning of a re-write of the UI to support full text query building and CAML queries.

Source code checked in

kindohm — Wed, 12 Mar 2008 13:54:27 GMT

Source code checked in

kindohm — Wed, 12 Mar 2008 13:15:52 GMT

Source code checked in

kindohm — Thu, 21 Feb 2008 20:34:32 GMT

Source code checked in

kindohm — Wed, 20 Feb 2008 20:58:24 GMT

Contains "Alpha" bits for CAML queries. Untested.

UPDATED WIKI: SharePoint Search Bench API Guide

kindohm — Mon, 18 Feb 2008 19:27:19 GMT

SharePoint Search Bench API Guide

Refer to the CHM help file in the current lease for detailed API documentation.

// example object model keyword query
Search search = new Search();
search.SearchType = SearchType.Keyword;
search.SearchText = new SearchTexst("dog cat llama");
Uri siteUri = new Uri("http://SharePointSite");
search.ContextUri = siteUri;
search.ApiSource = ApiSource.ObjectModel;
DataSet results = search.Execute();

// example service full text query
Search search = new Search();
search.SearchType = SearchType.FullText;
NetworkCredential credentials = CredentialCache.DefaultCredentials;
Uri serviceUri = new Uri("http://SharePointSite/_vti_bin/Search.asmx");
search.SearchText = new SearchText("SELECT Title, Author FROM Scope() " +
    "WHERE FREETEXT(DEFAULTPROPERTIES, 'dog cat llama') " +
    "ORDER BY RANK");
search.Credentials = credentials;
search.ApiSource = ApiSource.Service;
search.ContextUri = serviceUri;
DataSet results = search.Execute();

UPDATED WIKI: SharePoint Search Bench API Guide

kindohm — Mon, 18 Feb 2008 19:26:48 GMT

SharePoint Search Bench API Guide

// example object model keyword query
Search search = new Search();
search.SearchType = SearchType.Keyword;
search.SearchText = new SearchTexst("dog cat llama");
Uri siteUri = new Uri("http://SharePointSite");
search.ContextUri = siteUri;
search.ApiSource = ApiSource.ObjectModel;
DataSet results = search.Execute();

// example service full text query
Search search = new Search();
search.SearchType = SearchType.FullText;
NetworkCredential credentials = CredentialCache.DefaultCredentials;
Uri serviceUri = new Uri("http://SharePointSite/_vti_bin/Search.asmx");
search.SearchText = new SearchText("SELECT Title, Author FROM Scope() " +
    "WHERE FREETEXT(DEFAULTPROPERTIES, 'dog cat llama') " +
    "ORDER BY RANK");
search.Credentials = credentials;
search.ApiSource = ApiSource.Service;
search.ContextUri = serviceUri;
DataSet results = search.Execute();

UPDATED WIKI: Home

kindohm — Mon, 18 Feb 2008 19:24:31 GMT

Version 1.1.0.0 has been released!

Visit the Releases tab for details.

Project Description

System Requirements

Microsoft Office SharePoint Server (MOSS). WSS only is not enough!
.NET 3.5 (for running the desktop application)

Aids and References

SharePoint Search Bench API Guide
Example Full Text SQL queries
Writing SQL Syntax Queries for Relevant Results in Enterprise Search: http://msdn2.microsoft.com/en-us/library/bb219479.aspx
QueryPacket / Schema for Enterprise Search (search web service): http://msdn2.microsoft.com/en-us/library/ms563775.aspx

UPDATED RELEASE: SharePoint Search Bench v1.1.0.0 (Feb 18, 2008)

Mon, 18 Feb 2008 19:23:56 GMT

This release contains a few new features. One significant addition is the introduction of the FullTextBuilder class to the API. This class assists in generating full text search phrases without the developer needing knowledge of how to construct them. Also included is support for verbose logging using log4net.

Source code checked in

kindohm — Mon, 18 Feb 2008 19:12:14 GMT

Source code checked in

kindohm — Mon, 18 Feb 2008 19:12:09 GMT

Source code checked in

kindohm — Mon, 18 Feb 2008 19:11:07 GMT

CREATED FEATURE: API CHM documentation

kindohm — Mon, 11 Feb 2008 03:38:42 GMT

API CHM documentation.

CREATED FEATURE: Add support for SPQuery/CAML queries

kindohm — Wed, 06 Feb 2008 14:23:40 GMT

Add support for SPQuery/CAML queries

CREATED FEATURE: Full text query builder

kindohm — Mon, 04 Feb 2008 04:25:21 GMT

A set of classes that assists with writing full text queries.

CLOSED FEATURE: Eliminate QueryPacket XML templates

kindohm — Mon, 04 Feb 2008 04:22:46 GMT

The app currently relies on user-customizable XML strings for the web service QueryPacket XML. It uses replaceable parameters to fill in the query text, returned columns, etc. Instead of relying on the template XML, the entire query packet XML should be able to be generated on the fly from user input.
Comments: Fixed and released.

CLOSED ISSUE: web service url inference

kindohm — Mon, 04 Feb 2008 04:22:17 GMT

Be able to infer the web service url. If a user types in "http://server" when the Web Service connection method is being used, the app should be smart enough to automatically add "/_vti_bin/search.asmx" to the end of it if that portion of the Url is not present. Otherwise the app throws an exception and crashes if the app url is not found.
Comments: Fixed and released.

Source code checked in

kindohm — Fri, 01 Feb 2008 19:48:56 GMT

Added log4net support and logging classes.