Configuring the Google Search Box for SharePoint

Google Search Box for SharePoint version 3.0
Connector software version 3.0
Connector Manager version 3.0
Installer version 3.0

The Searchbox for Sharepoint is deprecated. The last supported version is 3.2.



Read this document to learn how to install and configure the Google Search Box for Sharepoint (Search Box). Search Box replaces the native Microsoft SharePoint search facility, serving results with the Google Search Appliance. This document also explains how to work with the SAML Bridge for Windows, and describes test utilities you can use with Search Box.

This document is for SharePoint administrators, Google Search Appliance administrators, and others who install or configure SharePoint or the Google Search Appliance.

Note: Before you install the Google Search Box for SharePoint, you must deploy the Google Search Appliance Connector for SharePoint.

Introducing the Google Search Box for SharePoint

The Google Search Box for SharePoint replaces the native SharePoint site search with search provided by the Google Search Appliance, while retaining the look-and-feel of the native SharePoint search facility.

Google Search Box for SharePoint

The Google Search Box for SharePoint will use the current searcher’s SharePoint credentials to determine access to documents.

The installer for the Search Box is shipped with a default stylesheet that is deployed on the SharePoint host. The stylesheet renders search results with the look and feel of SharePoint.

The Search Box always performs Public and Secure searches.

Use the Search Box to search all documents indexed by the search appliance, including non-SharePoint content. The Google Search Box for SharePoint is enabled on all SharePoint web applications on a machine that share the same search control. You cannot enable the Google Search Box on select SharePoint applications on a particular host, without enabling it on others. By default search box is installed on all web applications with the installer. If it is to be installed on a single web application only, then some manual steps need to be performed.

To restrict search to a limited number of URL patterns, typically a site or a list, configure collections in GSA. You can also configure the Search Box to search over multiple collections.

Authentication on the Search Box is performed silently; the Search Box uses the currently logged-in user for authorization and does not ask users to enter their credentials again. The Search Box supports the HTTP Basic, Kerberos authentication, and NTLM protocols, with some constraints.

The Search Box takes advantage of the full Google Search Appliance search protocol, including SharePoint document and item properties that are fed to the appliance by the Google Connector for SharePoint.

The Google Search Box for SharePoint does not replace the native SharePoint Search Service. The Search Box replaces the search control of the master template. The set of search web parts that come with SharePoint continue to function and still use the SharePoint Search Service.

The Search Box is deployed on Microsoft SharePoint Server. The Search Box uses the web.config file for the SharePoint web applications for storing configuration information.


How the Google Search Box for SharePoint Works

Here is an overview of the search process using the Google Search Box for SharePoint (Search Box).

  1. Users initiate a search by entering search terms in the Search Box.

  2. The Search Box submits a request to the Google Search Appliance.

  3. The Search Box passes the security context of the current user to the search appliance.

  4. The search appliance responds to the search request and returns search results according to the user’s access.

  5. The Search Box processes the response from the search appliance and displays the results in a format that resembles the SharePoint search interface.


Before You Install

Before you can use the Google Search Box for SharePoint:

  • Install the Google Search Appliance Connector for SharePoint

  • Use the Connector to index the SharePoint repository.

On sites using Kerberos:

  • Ensure that Kerberos is enabled according to the instructions in the section Crawl, Index, and Serve in Managing Search for Controlled-Access Content.

  • Activate Integrated Windows Authentication on the Google Search Appliance.

  • Ensure that the parameter Impersonate is set to true in the web.config of the corresponding SharePoint web application.

  • The Impersonate setting enables the Search Box to pass the correct security context for the currently logged-in user to the search appliance for authorizing search results.

On sites using NTLM authentication:


System Requirements

The hardware and software requirements for the Google Search Box for SharePoint are the same as for the Google Search Appliance Connector for SharePoint, which is documented at Connector documentation.

The Search Box is supported with the following web browsers:

  • Microsoft Internet Explorer 6.0, 7.0, and 8.0
  • Mozilla Firefox 3.0.5

Use this table to collect the values you need to install and configure the Search Box for SharePoint.

 
Parameter Description Your Value
Google Search Appliance URL The URL of the search appliance front end. This is typically http://appliance_ip_address or https://appliance_ip_address. The value of appliance_ip_address can be the search appliance host name or IP address.  
Collection The search appliance collection which will be queried by search requests; for example, default_collection. You can use one or multiple collections. For complete information, see Searching Over Multiple Collections.  
Stylesheet Stylesheets are used to render the search results. When you configure the Search Box, you can deploy the default stylesheet provided with the installer or you can use the search appliance front end stylesheet.

Choose the option “Use local stylesheet” to deploy the pre-bundled stylesheet and use it for rendering search results.

Choose option “Use Search Appliance’s Front End” to use the stylesheet associated with the specified Front End for rendering the search results.

This requires to configure and setup a front end on GSA using the desired stylesheet to have a SharePoint like look and feel (see Customizing the Search Appliance Front End).

 
Event Log The Search Box for SharePoint logs all messages to the event log. By default, only error messages are logged under the Google Search Box for SharePoint category. For detailed logging select the Verbose option.  

How Security is Supported

Search Box security configuration depends on how your SharePoint installation manages security.

  • If the SharePoint installation uses Basic authentication, you do not need to perform any special configuration to use the Search Box.

  • If the SharePoint installation uses Kerberos authentication with the Impersonation parameter set to True in the web.config file, you need to make some changes in client browser configuration. For complete instructions, see Changing Browser Settings for Kerberos.

  • If the SharePoint installation uses NTLM, ensure that Windows Integrated Authentication (SAML Bridge) is enabled.


Installing the Google Search Box for SharePoint

Use these instructions to deploy the Google Search Box for SharePoint. If you have a SharePoint server farm, you must perform the installation on each SharePoint host machine.

The Google Search Box for SharePoint is bundled in an installer with Google Services for SharePoint and the GSA Resource Kit for SharePoint. You can install each software component individually, but Google recommends that you install all of the components.

The installation instructions differ depending on whether you are installing the Search Box for SharePoint on an NTLM site or a Kerberos site.


Installing the Search Box on an NTLM Site

Before you install the Search Box on an NTLM site, ensure that the following tasks have been performed:

  • After the connector indexes the SharePoint content, run some test searches to make sure that secure results are returned correctly.

  • Ensure that the SAML bridge and search box are installed on the same host.

  • You must install all of the components that are included in the Google Search Appliance Resource Kit for SharePoint.

To install the Google Search Box for SharePoint, Google Services for SharePoint, and the GSA Resource Kit:

  1. Log in to the SharePoint Server host as a user with sufficient privileges to install software.

  2. If a previous version of Google Services for SharePoint is installed, uninstall it.

  3. Start a browser and navigate to the connector download site and download the Google Search Appliance Resource Kit for SharePoint installer to the SharePoint host (GSARKS Installer).

  4. Double-click the Google Search Appliance Resource Kit for SharePoint_x86(64).msi file.

    The installer starts and displays a welcome panel.

  5. Click Next. The License Agreement screen is displayed.

  6. Accept the License Agreement and click Next. The Setup Type screen is displayed.

  7. Select Custom and click Next. The Custom Setup screen is displayed.

  8. Select the components that you want to install and click Next.

  9. Click Install. The Port Number Configuration screen is displayed.

  10. Enter the port number and click OK. The port must be an unused port between 1024 and 65535.

  11. Click Next. The installer installs the software.

  12. Read the optional verification dialog box, which you can use to ensure that the web services are installed correctly and reachable.

     
    Parameter Name Description
    Local SharePoint Web Site URL The SharePoint web site URL for sites hosted on the machine where the custom web services are installed. Enter a valid SharePoint web site URL.
    Username The name of the SharePoint user who has access to the web site, for example, Administrator.
    Password The password for the SharePoint user.
    Domain The domain of the user
  13. Click Close.

  14. Click Continue.

    The installer displays a form on which you enter values that are used when search requests are sent to the Google Search Appliance.

  15. In the Appliance URL field, type the search URL for the Google Search Appliance.

  16. In the Collection field, type the search appliance collection that you want queried during searches.

    For information on using multiple collections, see Searching Over Multiple Collections.

  17. To log all messages to the Windows event log, choose Verbose.

    The default is to log only error messages. If you choose Verbose, you enable detailed logging.

  18. Click Save.

  19. Type in the Local SharePoint Website URL.

  20. Type in the Domain, Username, and Password for the domain.

  21. Click Verify.

    The installer verifies the ability to connect to Google Services for SharePoint with the credentials provided.

  22. Type in the GSA Artifact Consumer URL for the SAML bridge.

  23. To raise the logging level, check Enable debug logs.

  24. Click Save.

  25. Click Finish.

After Installing on an NTLM Site

After you finish the Search Box for SharePoint installation process on an NTLM site, complete the follow tasks, which are described in full in Enabling Windows Integrated Authentication at Product documentation.

  1. Follow the steps in the section “Configuring Authentication Requirements for the Login aspx File.”

  2. Follow the steps in the section “Modifying the Windows Registry.”

  3. Follow the steps in Granting the ‘Act as Part of the Operating System’ Privilege.

  4. Verify the SAML Bridge installation by following the steps in Verifying the Setup.

    • The URL for the GSA Simulator is http://saml_bridge_host:saml_bridge_port/gsa-simulator/SamlArtifactConsumer.aspx

    • If you test the SAML Bridge with the GSA Simulator and you use a URL that is protected by NTLM, you see the status Deny. This is the expected behavior.

  5. Configure the SAML Bridge with the Google Search Appliance, using the steps in Enabling Windows Integrated Authentication.


Installing the Search Box on a Kerberos Site

Before you install the Search Box on a Kerberos site, ensure that the following tasks have been performed:

  • Ensure that Kerberos is enable on the Google Search Appliance.

  • After the connector indexes the SharePoint content, run some test searches to make sure that results are returned without any pop-up windows.

Install all of the components that are included in the Google Search Appliance Resource Kit for SharePoint except the Google SAML Bridge for Windows.

To install the Google Search Box for SharePoint, Google Services for SharePoint, and the GSA Resource Kit:

  1. Log in to the SharePoint Server host as a user with sufficient privileges to install software.

  2. If a previous version of Google Services for SharePoint is installed, uninstall it.

  3. Start a browser and navigate to the connector download site.

  4. Click Next. The License Agreement screen is displayed.

  5. Accept the License Agreement and click Next. The Setup Type screen is displayed.

  6. Select Custom and click Next. The Custom Setup screen is displayed.

  7. Select the components that you want to install and click Next. Do not select Kerberos.

  8. Click Install. The Port Number Configuration screen is displayed.

  9. Enter the port number and click OK. The port must be an unused port between 1024 and 65535.

  10. Click Next. The installer installs the software.

  11. Read the optional verification dialog box, which you can use to ensure that the web services are installed correctly and reachable.

     
    Parameter Name Description
    Local SharePoint Web Site URL The SharePoint web site URL for sites hosted on the machine where the custom web services are installed. Enter a valid SharePoint web site URL.
    Username The name of the SharePoint user who has access to the web site, for example, Administrator.
    Password The password for the SharePoint user.
    Domain The domain of the user
  12. Click Close.

  13. Click Continue.

    The installer displays a form on which you enter values that are used when search requests are sent to the Google Search Appliance.

  14. In the Appliance URL field, type the search URL for the Google Search Appliance.

  15. In the Collection field, type the search appliance collection that you want queried during searches.

    For information on using multiple collections, see Searching Over Multiple Collections.

  16. To log all messages to the Windows event log, choose Verbose.

    The default is to log only error messages. If you choose Verbose, you enable detailed logging.

  17. Click Save.

  18. Type in the Local SharePoint Website URL.

  19. Type in the Domain, Username, and Password for the domain.

  20. Click Verify.

    The installer verifies the ability to connect to Google Services for SharePoint with the credentials provided.

  21. Click Save.

  22. Click Finish.


Verifying that the Search Box for SharePoint is Working

Use these instructions to verify that the installation and configuration process succeeded.

To verify that the Google Search Box for SharePoint is working:

  1. Open a browser.

  2. Navigate to the SharePoint site where the Search Box for SharePoint is installed.

  3. Verify that the search box within SharePoint displays a gray Google logo.

  4. Perform a search on content known to you to be present. If the required security conditions are met, you are not prompted to enter user credentials.


Postinstallation Tasks

After you install the Google Search Box for SharePoint, perform the following postinstallation tasks.


Customizing Individual SharePoint Web Applications

After you complete the installation process, you can optionally customize the settings for each SharePoint web application.

To customize the settings, click Start > All Programs > Google Search Box for SharePoint > Configuration Wizard.


Changing Browser Settings for Kerberos

When Kerberos is enabled on the Google Search Appliance, you must modify the browser configuration on each client host to use Kerberos for authentication and authorization. For more information on using Kerberos, see Crawl, Index, and Serve in Managing Search for Controlled-Access Content.

To configure Mozilla Firefox:

  1. Start Firefox.

  2. In the address bar, enter the following command:

    about:config

  3. Double-click network.negotiate-auth.trusted-uris.

  4. In the Enter string value dialog box, enter the search appliance URL as a trusted URI, but do not include the protocol (for example, http).

  5. Click OK.

  6. Double-click network.negotiate-auth.delegation-uris.

  7. In the Enter string value dialog box, enter the search appliance URL as a delegation URI, but do not include the protocol.

To configure Microsoft Internet Explorer:

  1. Start Internet Explorer.

  2. Click Tools > Internet Options and choose the Security tab.

  3. Select Local Intranet and click the Sites button.

  4. Click the Advanced button.

  5. In the Add this Web site to the zone field, enter the search appliance URL for the HTTP protocol and click Add.

  6. Enter the search appliance URL for the HTTPS protocol and click Add.

  7. Click Close.

  8. Click OK.

  9. In the section Security level for this zone, click Custom level.

  10. In the User Authentication section, select Automatic logon with current username and password.

  11. Click OK.

  12. Click the Advanced tab.

  13. In the Security section, check Enable Integration Windows Authentication (requires restart).

  14. Click OK.

  15. Restart Internet Explorer.

To verify Kerberos setup on the search appliance, run a secure search. You should not see a pop-up dialog box requesting user credentials.

Updating Search Box for SharePoint Parameters

After installation, you can update any of the Search Box for SharePoint parameters.

To update Search Box parameters:

  1. Click Start > Programs > GSA Resource Kit for SharePoint > Google Search Box for SharePoint > Configuration Wizard.

  2. Click Edit for any parameter you want to change.

  3. Click Ok.

  4. Update any GSA settings.

  5. Click Save.

Viewing Search Box Logs

To view Search Box logs:

  1. Click Start > Programs > GSA Resource Kit for SharePoint > Google Search Box for SharePoint > View Logs.

    The folder containing the logs is opened.

  2. Open a log in a text editor or other application.

    The log file names are in the format web_application_name_web_application_port_yyyy_mm_dd.log.

Customizing the Google Search Box for SharePoint

You can customize the appearance of the Search Box results page. You can do this in several ways.

Using Existing SharePoint Stylesheets

You can use custom stylesheets that you developed for SharePoint with the Google Search Box.

Custom stylesheets are scoped at the SharePoint web application level. Any changes you make are applied to all web sites of all SharePoint site collections for a particular web application.

To apply a stylesheet to a SharePoint web application:

  1. In a text editor, open the web.config file for the web application.

  2. Locate the appSettings section.

  3. Search for the key xslSP2result.

  4. Change the value attribute of the key to the absolute path of the new stylesheet.

  5. Save the web.config file.

Customizing the Search Appliance Front End

If you want to use search appliance's front end, do the following steps:

  1. Open the GSA admin console and open Serving -> Front End.

  2. Create a new front end by providing a name. You need to provide this name in the search box configuration wizard.

  3. Edit the front end. Open 'Search results' menu.

    Google Search Box for SharePoint front end config

  4. Un-check 'Search box (top)' and 'Search box (bottom)' check boxes. Save the options by clicking on 'Save the page layout code' button.

  5. Go to Google Search Box for SharePoint’s Configuration Wizard, in “Stylesheet” selection, select “Use Search Appliance’s Front End” radio button, and enter the front end name which was created in the previous step. Then click “Save.”

Searching Over Multiple Collections

Collections are used for limited searches based on URL patterns. The Search Box can perform searches over multiple search appliance collections.

To configure search over multiple collections, click Start > All Programs > Google Search Box for SharePoint > Configuration wizard and edit the Collection parameter. To specify searching over multiple collections, use the pipe symbol (|) as a separator:

default_collection|my_collection

Troubleshooting the Google Search Box for SharePoint

This section provides information on logging, error messages and using the Google Search Box test utility.

Logging

Logging is a useful technique for recording information about how your installation is operating. You can use the information logged for troubleshooting the operations of the Search Box, the Google Search Appliance, and Microsoft SharePoint Server.

The Search Box logs its messages to the Event Log under Application Log. Google Search Box for SharePoint is the event source.

By default, information-level logging is disabled and only error messages are shown in the logs. To enable information-level logging, check the option Verbose on the configuration wizard. This is especially helpful for troubleshooting.

To display the logs generated by the Search Box for SharePoint, click Start menu > All Programs > Google Search Box for SharePoint > View Logs.

It is recommended that the Verbose logging be turned on only for troubleshooting problems.

Error Messages

This section describes some commonly-encountered error messages and how to correct the problems.

 
Problem Solution
The following error message is displayed at installation time:

Error: SharePoint 2007 installation not found

The error message indicates that the installer cannot find SharePoint on the host where you are trying to install the Search Box. You must install the Search Box on the SharePoint host.
The following error message is displayed when a search is performed using the Search Box:

The remote name could not be resolved: GSA_URL

Ensure that the Google Search Appliance can be reached from the host machine.
The following error message is displayed when a search is performed using the Search Box:

Invalid URI: The Authority/Host could not be parsed.

or

Invalid URI: The hostname could not be parsed.

Ensure that the Appliance URL was entered correctly.
The following error message is displayed when a search is performed using the Search Box:

The remote name could not be resolved: Appliance_URL.

Ensure that the Appliance URL is reachable. Open a browser and type the appliance URL in the address bar. You should see the GSA search interface.
The following error message is displayed when a search is performed using the Search Box:

The remote server returned an error: (500) Internal Server Error.

Ensure that the configuration parameters for the search appliance were entered correctly during Search Box installation.
The following error message is displayed when a search is performed using the Search Box:

401 Unauthorized

Ensure that the browser is correctly configured to use the same authentication mechanism that is used by SharePoint. Ensure that the same search works from the search appliance Admin Test Center, using the same browser. Check that all the steps in Search Box installation instructions were correctly followed. Use the Search Box test utility to debug the authentication headers exchanged by the browser and confirm that they correspond to the authentication mechanism used by SharePoint.

Using the Google Search Box Test Utility

Use the Google Search Box test utility for verifying Search Box parameters. When you run the utility, it displays search request parameters, headers, cookies, the identity of the currently-logged-in user, and the name of the user whose context is used for search requests.

The test utility is an additional component that is bundled with the Google Search Appliance Resource Kit for SharePoint. Deploy the test utility as an IIS web site or a virtual directory.

To deploy the test utility as a virtual directory:

  1. Start a browser.

  2. Navigate to the connector download site and download the Google Search Appliance Resource Kit for SharePoint installer.

  3. Open IIS Manager by clicking Start > All Programs > Administrative Tools > Internet Information Services (IIS) Manager.

  4. Right-click the web site where you want to create the virtual directory.

  5. Click New> Virtual Directory.

  6. Click Next.

  7. Enter GoogleSearchBoxTestUtility as the Alias and click Next.

  8. Browse to the path where the directory GoogleSearchBoxTestUtility is located.

  9. Check all the checkboxes for permissions.

  10. Click Next.

  11. Click Finish.

To use the test utility to verify the Search Box:

  1. Start the configuration wizard for the Google Search Box by clicking Start > All Programs > Google Search Box for SharePoint > Configuration Wizard.

  2. Click Edit for the web application you are configuring.

  3. Enter the Appliance URL as the URL for the Google Search Box test utility.


Uninstalling the Google Search Box for SharePoint

Uninstalling the Google Search Box for SharePoint removes the software from the host and resets the parameters to their original state in the web.config file for all web applications.

To uninstall the Search Box:

  1. Start the installer from one of the following entry points:

    • Start > All Programs > Google Search Box for SharePoint > Uninstall

    • Start > Control Panel > Add or Remove Programs > Google Search Box for SharePoint.

    • Double-click the GSBI.msi file, which is the installer, and select the uninstall option.

  2. Run the uninstaller to completion.


Uninstalling Google Services for SharePoint

Uninstalling Google Services for SharePoint removes the software from the host.

To uninstall Google Services for SharePoint:

  1. Start the installer from one of the following entry points:

    • Start > All Programs > Google Resource Kit for SharePoint > Uninstall

    • Start > Control Panel > Add or Remove Programs > Google Resource Kit for SharePoint.

  2. Run the uninstaller to completion.

Was this helpful?
How can we improve it?