How to switch your DrupalCloud site from the GSA module to the CSE module

Google Search Appliance discontinued Google has discontinued their enterprise Google Search Appliance (GSA) product and will not be renewing MIT’s license for our on-campus appliance. As of the end of June 2018, the Google Search Appliance will no longer be available to MIT web site owners for custom search. In its place, we recommend web site owners use a Google Custom Search Engine (CSE). Please see Adding a Search Box to your MIT website for more information on the options available to MIT web site owners.

Context

This article explains how to switch your DrupalCloud site from using the MIT Google Search Appliance Drupal module to using the MIT Custom Search Engine Drupal module. This article is intended for DrupalCloud site owners. Note that not all DrupalCloud sites use the Google Search Appliance module. But if you enabled this module on your DrupalCloud site, this article will be relevant to you.

Answer

On June 22nd, 2018, MIT's license for our Google Search Appliance (GSA) will expire. As mentioned above, Google is not renewing licenses for this product. In preparation for this change, IS&T will be deploying a Google Custom Search Engine (CSE) and a CSE Drupal module to DrupalCloud. This module will be available to all DrupalCloud sites.

The new module is expected to be available on test sites by June 18th, 2018, and on production sites on June 21st, 2018.

What happens to your DrupalCloud site if you are using the GSA module and do nothing?

The existing GSA module will be decommissioned at the same time the CSE module is deployed, one day before the MIT GSA stops working. If you do nothing, the GSA search block will no longer appear on your pages. Nothing else on your site should be affected.

How do I re-enable search on my DrupalCloud site?

To re-enable search on your DrupalCloud site, place the built-in Drupal Search Form block in the same location where the GSA search block previously appeared.

How do I enable the new Google CSE search module?

To enable the use of the CSE you will need to do the following:

1. Optional: Under Home >> Administration >> Modules, scroll down to the CSE module and check the Enable box. The module may already be enabled if your site previously had the GSA module enabled, so this step is optional.
2. Under Configuration >> Search settings check the box next to Google CSE under Active Search Modules to begin using this search on your site. Optionally you may want to uncheck Node and User searches, depending on your use case.
3. Also in the Active Search Modules section you will want to select Google CSE as the default search module.
4. Under Home >> Administration >> Structure >> Blocks, scroll down to the Search form and set it's Region (via the pulldown menu) to the desired page region.

You may need to tweak any custom CSS for the search block and search results to include the new tags Google uses for CSE results.

See also

• Adding a Search Box to your MIT website