Skip to main content

Setup - Connector and Data Source Microsoft Sharepoint

Setting up a Connector Data Source that will include a Microsoft Sharepoint site

Updated over 4 months ago

Being Deprecated: This method of connection to Microsoft Sharepoint is being deprecated by SurePath AI in favor of using an AWS Knowledge Base (KB). The KBs provide a much better response that this method.

Overview

This document will cover the process of configuring SharePoint to allow SurePath AI to connect to specific SharePoint sites to index and tokenize them for use in a Retrieval-Augmented Generation (RAG) configuration. This will allow the data to be assigned to customer user groups and consumed as part of a private GenAI LLM ie. portal.surepath.ai

Setup is a two part process. The certificate used in Sharepoint is created after the Connector is created and the setup fails. You can then download the certificate and add it to your Azure setup. The system will continue to connect and will go Active once the certificate is installed.

It’s important to note that the certificate generated is for this connector only. This certificate can’t be used by other things, not can you use another certificate for this Connector.

High Level Steps

  • Create a new App Registration in Azure Entra that allows access to all SharePoint sites for your organization (granular control comes after this).

  • Enter information from Azure into the SurePath AI Connector setup.

  • Download the certificate from the SurePath AI UI

  • Install the certificate in the App Registration in Azure.

  • Add Data Contexts using this new Connector

Access is granted using the Microsoft preferred method of Azure AD App-Only

Customer Azure Setup

Prerequisites

You will need the following values to complete your configuration. Information on how to retrieve them will be included below.

Output Checklist

Please collect the following information at the end of this process:

  • Application (client) ID

  • Directory (tenant) ID

  • SharePoint URL

Create a new App Registration

Please use the search bar if the icon or name is not visible.

  • Select App registrations > New Application

  • Enter the name SurePath AI SharePoint Connector or another identifiable name.

  • Select Certificates & secrets > Certificates (0) > Upload certificate

  • Redirect URI (optional): Web

  • Leave the URI blank next to where you selected “Web”.

  • Select Register at the bottom of the page when done.

  • Capture the values from the following two items and get them to the SurePath engineers. In the future you will enter these into a self provisioning form in the SurePath Admin console.

    • Application (client) ID

    • Directory (tenant) ID

  • Select Manage > API permissions > Add a permission

  • Select the tile SharePoint

  • Select Application permissions

  • Select Sites.Read.All

  • Click the button Add permission at the bottom

  • Select Grant admin consent for {your organization here}

  • Select Yes on the pop-up screen.

  • The Status should have green checks on them now.

  • Leave this screen open, you will need to come back to it in a moment.

Configure the SurePath AI Connector

  • Select Connectors > Add Connector

  • Enter the name SharePoint or another identifiable name.

  • Select Microsoft Sharepoint from the Type dropdown

  • Enter the Sharepoint Base URL for your SharePoint environment (This must not include any "site" information (see graphic for example). That will be entered later.

  • Enter the Tenant ID and Client ID from the Azure configuration that you copied earlier.

  • Save the form

  • Ensure the Status is to PENDING or FAILED, either one is ok on this step.

Download the SharePoint certificate from SurePath AI

  • Scroll the Connector drawer and click DOWNLOAD CERTIFICATE

Install the SurePath AI certificate for this connector

  • Go back to your Azure window

  • Select Certificates & Secrets > Certificates (0) > Upload certificate

  • Click the blue File icon and secret find the certificate file from SurePath

  • Give it an appropriate Description

  • Click Add to save your changes

Did this answer your question?