Skip to main content

Google Search Appliance .NET solution

I recently worked on a project to integrate the search results from a Google Search Appliance into a .NET application. Although it seems like a pretty straight forward task, there were some small issues that I thought I might share.

Background
The communication with the Google Search Appliance is made simply with a HTTP GET request, which returns an XML formatted response. As for the Suggest service, the request looks about the same but the result returned is JSON encoded. For more information, please see the Google Search Appliance documentation, which is very extensive.

Internationalization
Since this solution was to incorporate several languages, the .NET application had to support and differentiate the languages. The GSA has very good built-in language support but there were at least one thing that was not completely obvious.

The GSA uses either HTTP headers or query string parameters to determine in which language the request is made. If neither of these are supplied the GSA may not return a correct response. This was the issue in our case, where we got unpredictable results in the spelling suggestions.

Summary: Always send an appropriate Accept-Charset and Accept-Language HTTP header.

XPath or LINQ to Xml?
There is already a publicly available .NET library (GSALib) to communicate with the Google Search Appliance, but for several reasons I chose not to use that library and build our own customized library. Since all responses from the GSA is XML formatted a key element in the communication is the XML parsing.

In .NET today there are basically two different choices, XPath or LINQ to XML. In the decision making process there were two key features to consider, ease of use and performance. MSDN published an article on this subject, Comparison of XPath and LINQ to XML. The following blog even took their time to make a little performance test, XPath vs LINQ to XML.

Summary: I chose LINQ to XML mostly because of its composition, which produces code that is easier to read and modify since we practically always read all elements in the XML file.

Comments

Popular posts from this blog

Binding a HTML-formatted string to a WPF WebBrowser control

Sometimes there is a need to display a HTML formatted string in a WPF application. There are a couple of ways to do this, but the most stright forward is to use a WebBrowser control and the NavigateToString method.

This approach has one big flaw, you cannot use binding to a string out of the box, but I found a great solution through Stack Overflow which adds a bindable property to the  WebBrowser control using  NavigateToString.

The following class is all that is needed to add that behavior. A new depencency property named Html is introduced to the  WebBrowser and the proper change action is performed in the OnHtmlChanged method.

public class BrowserBehavior { public static readonly DependencyProperty HtmlProperty = DependencyProperty.RegisterAttached( "Html", typeof(string), typeof(BrowserBehavior), new FrameworkPropertyMetadata(OnHtmlChanged)); [AttachedPropertyBrowsableForType(typeof(WebBrowser))] public static string GetHtml(WebBrowser browser) { …

Using Bootstrap Tooltip to show Parsley validation errors

I'm currently working on a web application using a variety of different frameworks, such as Backbone for the back-end, Bootstrap for the front-end and Parsley for client side form validation. Parsley is a really powerful validation toolkit, but it takes some tweaking to make it blend with the Bootstrap front-end. Fortunately this is a one time fix, which can be re-used all over our project.

Since there will be some custom options in our Parsley object, we can't use the default parsley-validate attribute on the form. Instead we have to initialize the validation with the jQuery syntax:

$('#my-form').parsley(parsleyOptions);
The options are were the magic happens, and in our case we have a global options object that our forms use to get the same experience all over the application. Here's what it looks like:

var parsleyOptions = {  // Sets success and error class to Bootstrap class names  successClass: 'has-success',  errorClass: 'has-error',  // Bo…

jQuery file upload with Bootstrap progress bar

Performing an asynchronous file upload from the browser is a common problem with almost as many solutions as there are developers. The following solution is the best fit for my needs, and also works well with most popular browsers. Backwards compatibility is not an issue in this case which is great, because I can use the new technologies as they are supposed to be used.

Everything is put together in JSFiddle for a working example. I will continue to explain the parts below...

First, the input field needs to be styled as a button. The form tag is only present for us to be able to reset the file input field later on.

<form>     <span class="fileUpload btn btn-default">         <span class="glyphicon glyphicon-upload"></span> Upload file         <input type="file" id="uploadFile" />     </span> </form>
.fileUpload { position: relative; overflow: hidden; } .fileUpload input { position: absolute; …