1. How does SQAI Suite Leverage This Integration?
Connecting to the Azure DevOps (ADO) Wiki allows SQAI to use your internal, up-to-date documentation as context for all automation tasks.
Contextual Accuracy: SQAI reads requirements, architecture guides, and process documentation directly from your Wiki 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 specific technical standards and language.
2. Information Required from Your Azure DevOps Account
To establish a secure, plug-and-play connection, we need four specific pieces of information, all of which can be quickly extracted from a Wiki page URL, plus a secure Personal Access Token (PAT).
The easiest method is to simply use a full Wiki URL for you to extract the information from
⚠️Example
https://dev.azure.com/**MY_ORGANIZATION**/**MY_PROJECT**/_wiki/wikis/**MY_WIKI_NAME.wiki**/1/Some-test-page
Example URL Breakdown
Required Detail | How to Find It in the URL | Example Value |
Organization Name | The first segment after |
|
Project Name | The second segment after |
|
Wiki Name | The segment after |
|
Personal Access Token (PAT) | Must be generated securely (See Section 3) |
|
3. Setting up the Integration
The most crucial step is generating a Personal Access Token (PAT) with the correct scope to ensure secure, read-only access to your documentation.
Step 1: Accessing User Settings
Action: Click the User Settings icon (often a gear or cog icon) located in the top right corner of the Azure DevOps interface.
Purpose: This opens a dropdown menu containing all user-specific configuration options, including security and permissions.
Step 2: Navigating to Personal Access Tokens
Action: In the dropdown menu, select "Personal access tokens" (as highlighted by the red box in the screenshot).
Purpose: This takes the user to the management page where they can create, view, or revoke the secure tokens needed for API access.
Step 3: Setting Necessary Scopes (Permissions)
On the PAT creation screen (after naming the token and setting expiration), scroll down to the scopes section and ensure the "Wiki" category is explicitly set.
❌ Note:
The user generating the PAT must have the necessary permissions to read the Wiki content.
PAT Scope Settings
When creating the PAT in Azure DevOps, ensure you set the following scope to grant SQAI the necessary permissions:
Category | Required Scope Setting |
Wiki | Read & Write (Allows SQAI to read documentation and folder structures for context.) |
Reference: For detailed steps on generating the PAT, please consult the Azure DevOps documentation: Use personal access tokens - Azure DevOps | Microsoft Learn
Now go to your Azure Wiki Configuration Page in SQAI and enter all required details and the PAT, then click "Save".
⚠️Quick Tip:
Azure DevOps Base URL (optional): You only have to provide this in case you have a custom Azure DevOps instance URL. You may leave this empty if you use the default URL (https://dev.azure.com).
4. Sync Azure Wiki with SQAI
Since Azure DevOps security policies prevent live-querying the Wiki by third-party apps, you must manually sync the required documentation pages.
Step-by-Step: Manually Syncing Azure Wiki 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 Azure Wiki space (e.g.,
Azure Wiki: SQAI.wiki) 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 Wiki 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 Wiki 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.
5. Troubleshooting
If you SQAI reports an error or fails to connect, use this checklist to quickly identify and resolve the most common integration issues.
Problem | Cause | Solution |
Connection Failed: "Unauthorized" or "Access Denied" | Incorrect PAT Scope: The Personal Access Token (PAT) is missing the required Read permission for the Wiki category. | Verify PAT Scopes: Go to User Settings > Personal access tokens and confirm the active token includes Wiki: Read permissions. |
Invalid Resource: Cannot Find Wiki | Incorrect Wiki Name Format: The Wiki name provided does not match the exact format, including the | Double-Check URL: Ensure the name is entered exactly as shown in the URL, e.g., |
SQAI simply does not connect | IP Restriction/Whitelisting: Your Azure DevOps instance could be secured by an additional organizational firewall or VPN, preventing external access. | Contact IT: If the instance is in a VPC, contact your IT team to whitelist a dedicated SQAI Suite IP address for inbound connections. (Contact the SQAI Team for a Static IP) |
PAT Expired | Token Expiration: PATs are set to expire after a certain period. | Generate New PAT: The PAT-generating user must create a new PAT with the required scopes and provide it to the SQAI Admin. |