1. How does SQAI Suite Leverage This Integration?
Connecting to SharePoint allows SQAI to integrate your organization's documentation into the QA workflow:
Contextual Accuracy: SQAI reads your requirements, guides, and technical specifications directly from SharePoint sites and folders to ensure generated test cases and scripts are aligned with the latest business logic.
Knowledge Grounding: Prevents SQAI from "hallucinating" or using generic information, ensuring all output is grounded in your organization's documentation.
2. Information Required from Your SharePoint Account
Connecting to SharePoint requires an App Registration within Microsoft Entra ID (formerly Azure Active Directory) to generate the necessary security credentials.
Required Detail | Explanation | How to Find It |
Tenant Name | The primary domain name for your SharePoint instance. |
|
Tenant ID (Directory ID) | A unique identifier for your Azure/Microsoft Entra organization. | See Section 3.1. |
Client ID (Application ID) | The unique ID of the App Registration created for SQAI Suite. | See Section 3.1. |
Client Secret | The confidential key generated for the App Registration. | See Section 3.2. |
SharePoint Site Name | The specific site within your tenant you want SQAI to read. | Found in your SharePoint URL. |
SharePoint Contents/Folder Name | The specific document library name (e.g., | Found under Site Contents (See Section 3.4). |
3. Setting up the App Registration (Microsoft Entra ID)
The most crucial step is setting up an App Registration to obtain the security credentials and grant read permissions.
3.1 Create App Registration & Retrieve IDs
Go to portal.azure.com and navigate to Microsoft Entra ID.
Select App registrations:
Click New registration to create a new application for SQAI.
Once created, navigate to the Overview page to find your required IDs:
Application (client) ID (This is the Client ID for SQAI).
Directory (tenant) ID (This is the Tenant ID for SQAI).
3.2 Generate Client Secret
Under the Manage menu for your new App Registration, select Certificates & secrets:
Click New client secret.
Copy the generated Value immediately. This is your Client Secret, and it will not be displayed again.
3.3 Set API Permissions
The App Registration must be granted permission to read your SharePoint sites.
Under the Manage menu, select API permissions.
Click Add a permission and select Microsoft Graph.
Select Application permissions.
Set the permission to Sites.Read.All (Read all sites) or the more secure Sites.Selected with the appropriate sites granted access.
3.4 Identify Site and Content Names
The final required items are the specific names of the documentation you want to sync.
Identify your SharePoint Site Name from your browser URL.
To find your content name, navigate to your site's content via the UI:
You must input the content name without spaces. Shared documents are automatically added.
4. Entering Details in SQAI Suite
Once you have secured your Client Secret and gathered all the necessary IDs, you can complete the setup in the SQAI Suite platform.
Step 1: Navigate to Integrations Go to your SQAI Suite settings and select the Integrations page. Find and select the SharePoint Online configuration.
Step 2: Enter Details Insert the following details into the corresponding fields:
Tenant ID
Tenant Name (e.g.,
tenant-name.sharepoint.com)Client ID
Client Secret
SharePoint Site Name
SharePoint Contents/Folder Name
Step 3: Save and Confirm Click "Save Configuration." If the set-up is successful, you will receive a success message and see a green indicator next to your SharePoint integration.
5. Troubleshooting SharePoint Integration
If SQAI reports an error or fails to connect, use this checklist to quickly identify and resolve the most common issues related to access.
Problem | Cause | Solution |
Connection Failed: "Unauthorized" | A. Missing/Incorrect Permissions: The App Registration is missing the required Sites.Read.All or Sites.Selected permission. | Verify API Permissions: Check the Microsoft Entra ID App Registration under API Permissions to ensure the necessary permissions are granted and Admin Consent has been applied. |
Invalid Content/Site | B. Incorrect Content Name: The folder name or site name contains a typo or spaces where none should exist. | Check Naming: Ensure the SharePoint Contents/Folder Name is entered without spaces (e.g., |
"Cannot Connect" | C. Client Secret Expired: The confidential key generated in Section 3.2 has expired or Sharepoint is hosted behind an additional firewall | Generate New Secret: Go to Certificates & secrets in the App Registration, create a new secret, and update the value in SQAI Suite or contact your admin to whitelist SQAI Suite. |
Generic Connection Error | D. Incorrect Tenant ID/Client ID: A typo exists in the globally unique identifier. | Double-Check IDs: Verify the Tenant ID and Client ID are copied exactly from the App Registration Overview page. |
5.1 Special Note: Using "Sites.Selected" Permissions
If your organization uses the Sites.Selected permission level (instead of the global Sites.Read.All), simply adding the permission in Entra ID is not enough. The application will remain "Unauthorized" until it is explicitly granted a role on the specific SharePoint site.
To resolve this, your SharePoint Administrator must run the following PnP PowerShell command to link the App Registration to your site:
# Parameters
$siteUrl = "https://yourtenant.sharepoint.com/sites/YourSiteName"
$clientId = "YOUR-APP-REGISTRATION-CLIENT-ID"
# 1. Connect to the site
Connect-PnPOnline -Url $siteUrl -Interactive
# 2. Grant the App Registration 'Read' or 'FullControl' access to this specific site
Grant-PnPAzureADAppSitePermission -AppId $clientId -DisplayName "SQAI Suite Integration" -Permissions Read -Site $siteUrl
Alternatively, via Microsoft Graph API: An admin can send a POST request to: https://graph.microsoft.com/v1.0/sites/{siteId}/permissions With the following payload:
{
"roles": ["read"],
"grantedTo": {
"application": {
"id": "YOUR-CLIENT-ID-HERE"
}
}
}IMPORTANT If you make these changes, it may take 5-10 minutes for Microsoft’s cache to update before the "Unauthorized" error disappears in SQAI Suite.
For more information please consult the following external links:
6. Sync SharePoint with SQAI
Since Azure DevOps security policies prevent live-querying SharePointby third-party apps, you must manually sync the required documentation pages.
Step-by-Step: Manually Syncing SharePoint Content
Navigate to Documentation Tool: In the SQAI Suite app, select the "Documentation Tool" under the "Train your instance" section on the left sidebar.
Select Documentation Space: Ensure the correct SharePoint space (e.g., SharePoint: YourSpace) is selected from the dropdown menu at the top.
Choose Pages (Left Side): Under the "Available content" section on the left, check the box next to the specific SharePoint pages you want SQAI to learn from (e.g., "Some test page").
Move to Trained Content: Click the right arrow (>) in the middle column. This moves the selected SharePoint pages from "Available content" into the "Trained content" section on the right side.
Sync & Train: Finally, click the "Sync & Train" button (highlighted by the large red arrow at the top right).
Once you click "Sync & Train," SQAI begins ingesting the documentation. This process takes place in the background to ensure the application remains fast and responsive.
Confirmation Message: You will immediately receive a success message confirming the job has started.
Follow Progress: To monitor the exact status, navigate to the "Jobs" section (located just below "Documentation Tool" on the left navigation bar).
Completion Status: You should monitor the progress of the job in the table. The process is fully complete and the documentation is ready for use by SQAI only when the status changes to "Sync Succeeded."
❌Note:
Pressing "Sync & Train" triggers SQAI to ingest and process the selected pages, making that documentation available for contextual prompting. If you make changes in Azure DevOps, you must repeat this process to update the VTE's knowledge.