Install a Search Client in SharePoint

Improve user experience across your sites with a search engine purpose-built for SharePoint. The SearchUnify search client for SharePoint is capable of delivering highly-personalized search results, irrespective of where your data is stored — on SharePoint or outside it.

The SearchUnify search client for SharePoint is highly customizable. You can tune results, create brand-compatible designs, and even run keyword-specific ads.

Prerequisites

Installation Overview

The installation takes place in three phases, each of which is divided into smaller steps. Altogether, the entire procedure doesn't take more than 30 minutes.

Download SharePoint Search Client

A prerequisite to downloading a SharePoint search client is to create it. If you have not already, then create a search client, connect it with content sources, and turn on analytics. Check out these articles for assistance: 

Once the SharePoint search client is ready, then proceed with its download.

  1. Go to Search Clients from main navigation.

  2. Find the SharePoint search client and hit .

Once you click , the SharePoint search client will be downloaded as a zip folder.

Prepare SharePoint Search Client

The zip folder is an app which can be installed on SharePoint after swapping placeholders with your SharePoint website URLs in six files. The of those files are JSON and in the root of the zipped folder. The remaining three files are XML—each in a folder of its own—in searchunify-app-sppkg (Windows) or searchunify-app-sppkg.zip (Linux). This section covers the details.

  1. Open (without extracting) the zip folder with Archive Manager or your favorite archive software, so that you can see the files.

  2. If your archive software sorts files by name, then the topmost file will be 0e5d489a-****.json. Open it in a text editor or IDE.

  3. In 0e5d489a-*****.json, find <!--YOUR WEBSITE PATH--->/ and replace it with the address—with the site and document library name—of your SharePoint site.

    Correct and Incorrect SharePoint Site Addresses

    Incorrect:https://websiteName.sharepoint.com/sites/

    Incorrect: https://websiteName.sharepoint.com/sites/nombre-de-sitio-web has only the site name.

    Correcthttps://websiteName.sharepoint.com/sites/nombre-de-sitio-web/biblioteca-documentos has both the site name and the document library name.

  4. Replace the placeholder in 17e33d53-****.json and d4b3b05b-****.json as well.

  5. Find searchunify-app.sppkg (Windows) or searchunify-app.sppkg.zip (Linux) and double click on it.

  6. Open the folder 0e5d489a-****, find WebPart_0e5d489a-7b77-4d8d-bd68-f603d9007e99.xml, open it and replace ["<!--YOUR WEBSITE PATH--->/"] with your website's name.

  7. Save the file and close it.
  8. Return to searchunify-app.sppkg (Windows) or searchunify-app.sppkg.zip (Linux) and repeat the steps 6 and 7 for folders 17e33d53- and d4b3b05b-. The XML files in these folders will be WebPart_{{FOLDERNAME}}.xml.

The SharePoint search client is now ready to be installed on a SharePoint website.

Deploy Search Client on SharePoint

In this section, you will find out how to install the downloaded search client—which is still a zip folder, despite the changes during preparation—on a SharePoint website as an app.

  1. Log into SharePoint and look up "Apps" in the search box.

  2. In the results, open My Apps.
  3. Go to Apps for SharePoint, click Upload, and upload only searchunify-sharpoint.sppkg from the zipped folder. Once you can see on SharePoint, click Deploy.

  4. Open Settings from the main navigation bar on the top, and click Add an App.

  5. On the Your Apps page, search for searchunify-app, double click on it, and then install searchunify-webpart-client-side-solution.

  6. Go to Document Library. The remaining where the rest of the search client files will be stored.

  7. Upload all the files from the zipped folder except for searchunify-app.sppkg in Document Library.

  8. Search searchunify-sharpoint, and from the results select searchunify-webpart-client-side-solution and install it.
  9. Go to Pages and open for editing the page on which the search client will be installed.

  10. Insert Su-PageRating, Su-Results, and Su-SearchBox on the page.

  11. Edit the Su-Results component, enter the search client UID, instance URL, and click Apply.

  12. Click Republish.

SearchUnify has been installed on SharePoint.

Last updatedFriday, September 4, 2020