Adding a SharePoint Source

You can add the content of a SharePoint farm to your Coveo organization.

You can index SharePoint 2010, 2013, 2016, Foundation 2010, and Foundation 2013 content and make it searchable. The SharePoint content is searchable by only you when you make the source private or all members of the Coveo organization when you share the source. Your SharePoint source starts an incremental refresh every 15 minutes to index SharePoint file changes (addition, modification, or deletion).

Source Features Summary

Features Supported Additional information
SharePoint version 2010, 2013, 2016, Foundation 2010, and Foundation 2013
Searchable content types Farms, Web applications, site collections, sites, user profiles1, personal websites1, lists, list items, list item attachments, document libraries, document sets, documents, Web parts2, and microblog posts and replies.
Content update Incremental refresh

Full refresh or rebuild is needed to retrieve deleted user profiles2.

Full refresh
Rebuild
Permission types Secured
Private
Shared

1: Not available in Microsoft SharePoint Foundation.

2: Not all Web parts are available in Microsoft SharePoint Foundation 2010 (see Overview of Web Parts available in SharePoint Foundation 2010).

Add a SharePoint Source

To edit a SharePoint source, see Edit the Source Configuration to Re-index its Content or Re-authorize the Access, and then follow the steps below, starting from step 6.

  1. Ensure your environment meets the following requirement:

    • Microsoft SharePoint 2010, 2013, or 2016

      OR

      Microsoft SharePoint Foundation 2010 or 2013

      Deprecated support versions: SharePoint 2007 (see Repository Version Support Deprecation)

    • Microsoft SharePoint server accessible to Coveo Cloud

      When the access to communication ports between Coveo Cloud and the SharePoint server is restricted, the appropriate port(s) must be opened in the network infrastructure such as in firewalls to allow Coveo Cloud to access the content.

  2. On your SharePoint farm:

    1. Select or create a user that the source will use to retrieve your SharePoint content. See the following table to identify the required type of user for your type of SharePoint environment.

      SharePoint environment SharePoint Web Application Enabled authentication Type of user User format
      Classic
      (2010 or 2013)
      Windows Windows account domain\username
      or
      username@domain.com
      Claims
      (2010 or 2013)
      Windows Windows account
      ADFS ADFS SSO
    2. Grant appropriate SharePoint permissions to the SharePoint account you selected to ensure access to all the content that you want to index.

      The following table presents the minimal required permissions that the indexing account must have to perform the specified action for the supported SharePoint versions.

      SharePoint version Action to perform Minimal required permission
      2013 2010
      Content and security indexing, incremental refresh, and site collection discovery Full Read policy for all SharePoint farm web applications (see Adding the Full Read Policy to All SharePoint Farm Web Applications).

      Personal site, user profile and social tags indexing

      When indexing personal sites or user profiles, the indexing account must not have a personal site on the SharePoint server being indexed to prevent connector failure cases when attempting to retrieve the list of personal sites.

      Read permission for the site collection of the source starting address (see Adding the SharePoint Website Read Permission).
      Retrieve People Data for Search Crawlers permission to the User Profile Service Application (see Adding the Retrieve People Data for Search Crawlers Permission to the User Profile Service Application).
  3. If not already done, log in to your Coveo organization.

  4. In the navigation bar on the left, under Search Content, select Sources, and then click Add Source.

  5. On the Add Source page, click SharePoint.

    When you create a source, you become the owner of the source.

  6. In the Add/Edit a SharePoint Source dialog box:

    Admin-AddSharePointSource

    1. In the Source Name box, enter a descriptive name of your choice for the source.

    2. In the URL box, enter the URL of your SharePoint farm.

    3. In the security drop-down menu, select if you want your SharePoint content to be Shared or Private (see Source Permission Types).

      If you select Shared, in search results, users can see all the items that the indexing account can access.

    4. In the Username and Password boxes, enter the credentials of the SharePoint account you selected or created before in step 2.

    5. Click Start Indexing (or Refresh Index when editing the source).

  7. Back on the Sources page, you can review the progress of your SharePoint source addition (see Review the State of Sources Available to You).

What’s Next?

What's Next for Me?