Allowing a JavaScript Search Page to Retrieve SharePoint Claims

CES 7.0.9093+ (September 2017)

When configuring a Coveo JavaScript search page, you may want to retrieve and leverage claims from your on-premises SharePoint instance (see Coveo JavaScript Search Framework). To do so, you must add a SearchApiClaims.aspx page to your SharePoint instance. Rather than adding it by installing the whole Coveo .NET Front-End web service, you can use a smaller installation kit to install the SearchApiClaims.aspx page only (see Coveo SharePoint web service).

To allow a JavaScript search page to retrieve SharePoint claims

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. Download and run the Coveo Claims Security Module install kit (see Coveo Product Updates).

4. In the Coveo Claims Security Module 1.0 Installation dialog box that appears, proceed with the module installation:

   

   1. In the Welcome to Coveo Claims Security Module 1.0 screen, click Next.

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

      

   3. In the Installing the program screen, click Install to begin the module installation.

      

   4. In the Installation Successful screen, click Finish to close the Coveo Claims Security Module install kit.

      

5. Edit the web.config file for your SharePoint site to complete installation, and then test your setup (see On-Premises SharePoint Claims Authentication) .

6. If not already done, create the appropriate security provider (see Microsoft SharePoint Connector Deployment Overview, Microsoft SharePoint Legacy Connector Deployment Overview, or Microsoft OneDrive for Business Connector Deployment Overview).