Skip to main content

SharePoint User Connector Setup Guide

This guide provides step-by-step instructions for creating and configuring a SharePoint connector with Abacus.AI's ChatLLM platform.

Prerequisites​

Before starting, ensure you have access to:

  • Abacus.AI platform
  • SharePoint environment with appropriate permissions
  • Administrative access to create connectors and projects

Step-by-Step Instructions​

1. Create SharePoint Connector​

Create a SharePoint connector by referring to User connector flow section in our public documentation:
SharePoint Connector Documentation

2. Navigate to Projects Page​

After creating the connector, navigate to the projects page by clicking on the ABACUS.AI logo.

3. Create New Project​

Click on "Create a new project" to begin setting up your ChatLLM project.

4. Select Project Type​

Choose GenAI --> Custom Chatbot option from the available project types.

5. Configure Project Name​

Enter a descriptive name for your project that reflects its purpose.

6. Skip to Dashboard​

Select "Skip to project dashboard" to proceed directly to the project configuration.

7. Access Model Training​

  1. Click on the Model option in the left toolbar
  2. Select "Train Model" in the top right corner of the page

8. Configure Advanced Options​

Navigate through the following menu structure:

  • Select Advanced Option
  • Choose Tool Use
  • Select Sharepoint_tool
  • Under Config Connectors option, select the connector you created in Step 1.

Note: You can add multiple SharePoint User connectors either within the same model or across separate models.

9. Initiate Model Training​

Click on "Train Model" to begin the training process.

10. Access Trained Model​

Once training is complete:

  1. Click on Models in the navigation
  2. Select your newly trained model

11. Create Deployment​

Click on "Create a new deployment" to make your model available for use.

12. Configure Deployment Type​

  1. Select "Offline Batch + Realtime" deployment option
  2. Click "Next" to proceed

13. Name Your Deployment​

Enter a user-friendly name that your end users will see, then click "Deploy".

14. Monitor Deployment Status​

  1. Return to your model by clicking Models → [Your Model Name]
  2. Wait for the deployment status to show as "Active"
  3. Click on the deployment name once active

15. Access Prediction Dashboard​

Click on the "Prediction Dash" option under the Deployment section.

16. Test Your Bot​

Click on "Go to Abacus.AI Chat" to access the testing interface.

17. Start Using the Chatbot​

  • Enter your questions or prompts in the chat interface
  • Note: Each user will be prompted to log in to SharePoint once for authentication

Permissions and Access​

When setting up the connector, the following permissions are requested. Please note that all the permissions are delegated permissions, consented to by each signed-in user.

The set requested depends on the Authentication Type selected on the config connector in Step 1. Basic (Read Only) and Write Access use two different Abacus.AI app registrations, so the write connector requests read/write scopes instead of the read-only ones.

Basic (Read Only)​

The connector can read SharePoint sites and files, but cannot create, modify or delete content.

Graph API scopes

  • Directory.Read.All: Read directory data
  • email: View users' email address
  • Files.Read.All: Read all files that user can access
  • offline_access: Maintain access to data you have given it access to
  • openid: Sign users in
  • profile: View users' basic profile
  • SensitivityLabel.Read: Get labels user scope
  • SensitivityLabels.Read.All: Get labels app scope
  • Sites.Read.All: Read items in all site collections
  • Sites.Selected: Access selected Sites, on behalf of the signed-in user
  • User.Read: Sign in and read user profile

SharePoint Scopes:

  • AllSites.Read: Read items in all site collections
  • MyFiles.Read: Read user files
  • Sites.Search.All: Run search queries as a user
  • Sites.Selected: Access selected site collections
  • User.Read.All: Read user profiles

Write Access​

In addition to reading, the connector can create, edit, upload and delete SharePoint files and items on behalf of the signed-in user. The read-only scopes above are replaced by their read/write equivalents.

Graph API scopes

  • email: View users' email address
  • Files.ReadWrite.All: Have full access to all files user can access
  • offline_access: Maintain access to data you have given it access to
  • openid: Sign users in
  • profile: View users' basic profile
  • SensitivityLabel.Read: Get labels user scope
  • SensitivityLabels.Read.All: Get labels app scope
  • Sites.ReadWrite.All: Edit or delete items in all site collections
  • User.Read: Sign in and read user profile
  • User.Read.All: Read all users' full profiles

SharePoint Scopes:

  • AllSites.Write: Read and write items in all site collections
  • MyFiles.Write: Read and write user files
  • Sites.Search.All: Run search queries as a user
  • Sites.Selected: Access selected site collections
  • User.Read.All: Read user profiles

Custom OAuth​

Your own app registration is used instead of the Abacus.AI one, so you must add the delegated permissions to it yourself — the Basic (Read Only) set for a read-only connector, or the Write Access set if your users need to create or modify SharePoint content.

These permissions allow the connector to pull the necessary data and, with Write Access, to write content back to SharePoint as the signed-in user.

Important Notes​

  • Authentication: Users will need to authenticate with SharePoint on their first interaction
  • Permissions: Ensure proper SharePoint permissions are configured for the connector
  • Sensitivity Labels: The connector supports Microsoft Purview sensitivity labels. If configured, files matching specified sensitivity labels can be excluded during data ingestion. Ensure the SensitivityLabel.Read delegated permission is granted.
  • Testing: Thoroughly test the connector with various SharePoint operations before deploying to end users

Troubleshooting​

If you encounter issues:

  1. Verify SharePoint connector configuration
  2. Check deployment status is "Active"
  3. Ensure proper authentication credentials
  4. Review SharePoint permissions and access rights