Installing the Coveo Web Service, Search Box, and Search Interface into SharePoint

The Coveo .NET Front-End can be integrated to an on-premises SharePoint by installing the following Coveo SharePoint web service, the Coveo search box, and the Coveo search interfaces components on all your SharePoint front-end servers.

Coveo SharePoint web service

The optional Coveo SharePoint web service installed on a SharePoint server enhances the Coveo SharePoint, SharePoint Legacy and OneDrive for Business (in a SharePoint 2013 or 2016 scenario) connectors ability to extract and index SharePoint content by providing:

• Full site collections discovery of the targeted SharePoint farms (see Configuring and Indexing a Microsoft SharePoint Source, Configuring and Indexing a Microsoft SharePoint Source With the Legacy Connector or Configuring and Indexing a Microsoft OneDrive for Business Source)

• Automatic crawling account configuration (see Automatic Permissions Setup)

• Possibility for end-users to log with SharePoint credentials in a Coveo search interface deployed outside of your SharePoint farm so that they can see SharePoint search results (see Adding Security Providers to a .NET Search Interface).

Note: Coveo .NET Front-End 12.0.99+ (March 2013) The Coveo SharePoint web service is optional only when all the content is indexed from a Classic SharePoint environment.

When indexing content from Web Applications using Claims-based Authentication Providers, the web service must be installed on the SharePoint server in order to add the following new features required by the Coveo Back-End and Mirror servers to handle Claims permissions:

• Convert permissions found on SharePoint document into Claims.

• Retrieve the list of Claims associated to a user performing a search in CES.

Coveo search box

You can also install the control for the Coveo search box on a SharePoint server and use it to replace the default SharePoint search box to get the benefits of the Coveo search results directly within SharePoint, providing another convenient Coveo access point.

Note: Installing the Coveo search box on the SharePoint server is optional and is not needed to deploy the Coveo SharePoint, SharePoint Legacy or OneDrive for Business (in a SharePoint 2013 or 2016 scenario) connector.

Tip: When the Coveo search box is installed on the SharePoint server, from the Interface Editor you can activate the Enable search as you type option in your SharePoint search interfaces to get quick search results directly under the search box (see Activating Search Interface Options With the .NET Interface Editor). Note that you must install the Default Search Interface to gain access to the Interface Editor.

Coveo search interfaces

When you choose to install the Coveo search box on your SharePoint server, you must also install Coveo search interfaces on the SharePoint server to present search results for queries performed from the Coveo search box.

Tip: You can configure the scope of each search interface using the Interface Editor(see Configuring the Scope of a .NET Search Interface).

Important: You must perform the following installation procedure for each web front-end server of your SharePoint farm, one after the other. You may see the An update conflict has occurred, and you must re-try this action. error message when installing concurrently on more than one server. You must also repeat this procedure each time you update or migrate the Coveo Platform on your Coveo Master server.

To install the Coveo SharePoint web service, search box, and search interface

1. Using a local administrator account, connect to the web front-end server of your SharePoint farm.

2. Ensure that the account you are using has the permissions presented in the following table.

   SharePoint version		Required permissions
   2016/2013/2010	2007
   ✓	✓	Member of the SharePoint server local Administrators group (see Adding the Crawling Account to the SharePoint Server Local Administrators Group)
   ✓	✓	Have the SQL Server system administrator server role (see Adding the Microsoft SQL Server System Administrators Role) OR Have the database owner role for the SharePoint configuration database and for all SharePoint content databases, including the Central Administration content database (see Adding the Database Owner Role for Microsoft SQL Server)
   	✓	Member of the SharePoint farm administrators group (see Adding the Crawling Account to the SharePoint Farm Administrators Group)

3. Run the Coveo .NET Front-End installer.

4. When a required version of Microsoft Chart Controls for Dotnet Framework is missing on the server, in the dialog box that appears, click Install.

   

5. When a required version of Microsoft .NET Framework is missing on the server, in the dialog box that appears, click Install.

   Note: The Microsoft components are installed through the Internet. When the installer does not have access to the Internet, prerequisite installations will fail. You must then install the components manually and restart the Coveo .NET Front-End installer.

6. In the installer welcome screen, click Next.

7. In the installer License Agreement screen, read the license terms, select I accept the terms in the license agreement, and then click Next.

8. In the Installing Folders screen:

   

   1. For each optional item in the list, click , and then ensure This feature will be installed on local hard drive. is selected for those that you want to install:

      • Search Interface - To install the search interface libraries used to handle search queries.

      • Default Search Interface - To install the default Coveo Enterprise Search web application and gain access to the Interface Editor.

        Note: When the Default Search Interface is not installed, you may get the The resource cannot be found error message when trying to access the Interface Editor from the search interface menu (Do more > Edit this interface).

      • SharePoint Web Service - Needed to allow the connector to automatically set permissions for the crawling account and to discover all site collections in the SharePoint farm.

      • SharePoint Search Interface - Needed when you want to integrate the Coveo SharePoint search interface in your SharePoint site.

      • Coveo Search Box - Needed when you want to replace the default SharePoint search box by the Coveo search box.

        Tip: Once installed on your SharePoint server, you can enable/disable the Coveo search box independently for each site (see Activating or Deactivating the Coveo .NET Search Box in a SharePoint Site).

   2. Click Next.

9. When you install the search interface and the search box, in the Configuration screen:

   1. Click Configure next to Web site hosting the interfaces.

   2. In the Web Interface Configuration screen:

      

      1. In the Web site name box, enter the name of the site to be created in IIS to host Coveo search interfaces.

      2. In the Web site port box, enter the port to access the Coveo search interfaces. The default is 8080.

      3. Click OK.

   3. Back in the Configuration screen, click Configure next to Coveo Enterprise Search server and port.

   4. In the CES Configuration screen:

      

      1. In the Server name box, enter the hostname of the Coveo Back-End server (where CES is installed) to which you want to connect this Front-End server. You can leave localhost when CES is also installed on the current server.

      2. In the Service port box, change the CES service port default (52810) only when needed (see About the CES Service Port).

      3. Click Test Server to validate that the CES service is responding and compatible with the Coveo .NET Front-End you are installing.

      4. In the dialog box that appears, review the message to validation is successful, and then click OK.

         

      5. Back in the CES Configuration screen, click OK.

   5. Click Next.

10. In the installer Installing the program screen, click Install.

    Coveo .NET Front-End 12.0.1548+ (June 2016) In a SharePoint farm with multiple Web Front-End (WFE) servers, you must install or update the Coveo .NET Front-End on each server. You can however speed up the installation by performing the changes to the SharePoint database only from the first server.

11. In the installer Installation Successful screen, click Finish.