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​
- Click on the Model option in the left toolbar
- 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 Connectorsoption, 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:
- Click on Models in the navigation
- 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​
- Select "Offline Batch + Realtime" deployment option
- 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​
- Return to your model by clicking Models → [Your Model Name]
- Wait for the deployment status to show as "Active"
- 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:
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: Read the user's sensitivity labels
- 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
These permissions allow the connector to pull necessary data.
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.Readdelegated permission is granted. - Testing: Thoroughly test the connector with various SharePoint operations before deploying to end users
Troubleshooting​
If you encounter issues:
- Verify SharePoint connector configuration
- Check deployment status is "Active"
- Ensure proper authentication credentials
- Review SharePoint permissions and access rights