ELITEA Toolkit Guide: qTest Integration

Introduction

Purpose of this Guide

This guide is your definitive resource for integrating and effectively utilizing the qTest toolkit within ELITEA. It provides a detailed, step-by-step walkthrough, from setting up your qTest API token to configuring the toolkit in ELITEA and seamlessly incorporating it into your Agents. By following this guide, you will unlock the power of automated test management, streamlined QA workflows, and enhanced collaboration between development and testing teams, all directly within the ELITEA platform. This integration empowers you to leverage AI-driven automation to optimize your qTest-driven workflows, enhance QA productivity, and improve software quality within your projects.

Brief Overview of qTest

qTest, by Tricentis, is a leading cloud-based test management platform designed to centralize and streamline all aspects of software testing. It is widely used by QA teams to manage test cases, execute test runs, track defects, and generate comprehensive reports. qTest offers a wide array of functionalities, including:

Integrating qTest with ELITEA brings these powerful test management capabilities directly into your AI-driven workflows. Your ELITEA Agents can then intelligently interact with your qTest projects and test assets to automate test management tasks, enhance QA processes, improve test coverage, and leverage AI to optimize your entire software testing lifecycle within qTest.

Toolkit's Account Setup and Configuration in qTest

Account Setup

qTest is a commercial test management tool and is available as a trial version for a limited period. To create a qTest account, follow these steps:

  1. Visit Tricentis Website: Open your web browser and navigate to the official Tricentis qTest website: https://www.tricentis.com/.
  2. Navigate to Trials & Demos: Click on "Trials & demos" in the main navigation menu to begin the trial registration process.
  3. Find qTest and Start Free Trial: On the "Trials & demos" page, locate the qTest section and click the "Free trial" button.
  4. Fill in Registration Form: The "Start your free 14-day Tricentis qTest Trial" message should be displayed, and a registration form will appear on the right side of the page. Provide the following basic information in the registration form:
    • Business email address: Enter your business email address (preferably your company email). QTest typically provides free trials for business email IDs.
    • First Name: Enter your first name.
    • Last Name: Enter your last name.
    • Country: Select your country from the dropdown menu.
    • Phone: Enter your phone number.
    • Job Title: Enter your job title.
  5. Submit Registration Form: After filling out the registration form, click the "Next Page" button to submit the form.
  6. Create QTest Web Address and Account Details: A new window will open, prompting you to fill in the details to create your new qTest web address and account credentials:
    • Username: Your username is prefilled based on your account registration. You can modify it if needed.
    • Create Your QTest Web Address: Enter a unique subdomain name in the field provided (e.g., alitatest). This subdomain will be used as part of your unique QTest web address to access your qTest trial account (e.g., alitatest.qtestnet.com).
    • Password: Create a strong password for your QTest account. Use a combination of uppercase letters, lowercase letters, numbers, and special characters to create a secure password.
    • Confirm Password: Re-enter the same password to confirm it.
    • qTest Data Storage Location: Select a preferred data storage location from the dropdown menu. Choose a location that complies with your organization's data storage and compliance requirements (e.g., United States, Europe).
    • Privacy Policy Review: Read the note regarding the data center location and compliance with jurisdictional laws. Review the Privacy Policy if necessary.
  7. Start My Trial: Once all fields are correctly filled, click the orange "Start My Trial" button to proceed and create your qTest trial account.
  8. Check Your Email for Confirmation: After submitting the form, you should receive a confirmation email from Tricentis qTest. This email may include a link to set up your qTest account and verify your email address. Follow the instructions in the email to complete the registration and activate your free trial.
  9. Access qTest: After verifying your email, you will be directed to the qTest platform. Log in using the username, password, and QTest web address you provided during registration.

Token/API Key Generation: Finding API Token in qTest

To securely integrate ELITEA with qTest, you need to obtain your qTest API token. This token will be used by ELITEA to authenticate and access your qTest projects and test data.

Follow these steps to find your API token in qTest:

  1. Log in to qTest: Access your qTest instance by navigating to your qTest web address (e.g., alitatest.qtestnet.com) and logging in with your qTest credentials.
  2. Access API & Webhooks Settings: Once logged in, navigate to your user profile settings. The exact location may vary slightly depending on your qTest version, but it is typically found under your profile menu or user settings. Look for options like "Integration Settings", "API Access", or "Webhooks". In newer versions of qTest, you can find it under "Manager" -> "API & SDK".

    qTest-API_Token_Location_1

    qTest-API_Token_Location_2

  3. Locate API Key/Token: In the "API & SDK" settings, you should find your Token or Bearer Token. It may be labeled as "Token", or "Brstrt Token".

  4. Copy and Store Your API Token: Copy the API token displayed on the page. Store it securely in a password manager or, preferably, ELITEA's built-in Secrets feature for enhanced security within ELITEA. You will need this API token to configure the qTest toolkit in ELITEA.

qTest-API_Token_Location_3

System Integration with ELITEA

Agent Creation/Configuration

To integrate qTest functionalities into your workflows, you will need to configure the qTest toolkit within an ELITEA Agent. You can either create a new Agent specifically for qTest interactions or modify an existing Agent to incorporate qTest tools.

  1. Navigate to Agents Menu: In ELITEA, go to the Agents menu from the main navigation panel.
  2. Create or Edit Agent:
    • Create a New Agent: Click on the "+ Agent" button to create a new Agent. Follow the on-screen prompts to define essential Agent attributes such as Agent name, a descriptive Agent description, the desired Agent type, and initial instructions for the Agent.
    • Edit an Existing Agent: Select the Agent you intend to integrate with qTest from your list of Agents. Click on the Agent's name to open its configuration settings for editing.
  3. Access Tools Section: Within the Agent configuration interface, scroll down until you locate the "Tools" section. This section is where you will add and configure toolkits, including the qTest toolkit.

Toolkit Configuration

This section provides detailed instructions on how to configure the qTest toolkit within your ELITEA Agent.

  1. Add Toolkit: In the "Tools" section of the Agent configuration, click on the "+" icon. This action will display a dropdown list of available toolkits that can be integrated with your Agent.
  2. Select qTest Toolkit: From the dropdown list of available toolkits, choose "qTest". Selecting "qTest" will open the "New qTest tool" configuration panel, where you will specify the settings for your qTest integration.
  3. Configure qTest Toolkit Settings: Carefully fill in the following configuration fields within the "New qTest tool" section:

    • Name: Enter a descriptive Name for your qTest toolkit instance. Choose a name that is easily recognizable and helps you identify its purpose within your Agent's instructions (e.g., "ProjectQTest", "TestManagementAccess", "QTestIntegration").
    • Description: Provide a concise Description for the toolkit. This description should clarify the toolkit's purpose or the specific qTest project it is intended to access (e.g., "Toolkit for accessing and managing test cases in qTest", "Integration for qTest Project 'Project Alpha'").
    • Base URL: Enter the base URL of your qTest instance API endpoint. Ensure you use the correct format: https://qtest.example.com (Replace qtest.example.com with your actual qTest subdomain).
    • Project ID: Enter the Project ID of the specific qTest project you want to connect to with this toolkit. The Project ID is a numerical identifier for your qTest project. You can typically find the Project ID in your qTest project settings or in the URL when you are within your qTest project.
    • Authentication Options - API Token: Select the "API Token" authentication option.
      • Password/Secret: Choose "Password" and paste the Bearer token you obtained from qTest (during the "Software-Specific Setup" section of this guide) into the "Password" field.
      • Enhanced Security with Secrets (Recommended): For enhanced security, it is strongly recommended to use ELITEA's Secrets Management feature to store your qTest API token securely. Instead of directly pasting the token into the "Password" field, select the "Secret" option and choose the pre-configured secret containing your qTest API token from the dropdown list. This prevents hardcoding sensitive credentials in your toolkit configuration.

    qTest-Toolkit_Configuration

  4. Enable Desired Tools: In the "Tools" section within the qTest toolkit configuration panel, select the checkboxes next to the specific qTest tools that you want to enable for your Agent. It is crucial to enable only the tools that your Agent will actually need to use to adhere to the principle of least privilege and minimize potential security risks. Available tools include:

    • Search by DQL - Allows searching for test cases using qTest DQL queries.
    • Create test cases - Enables the Agent to create new test cases in qTest.
    • Update test case - Allows the Agent to update existing test cases in qTest.
    • Find test case by ID - Enables the Agent to retrieve a specific test case by its ID.
    • Delete test case - Allows the Agent to delete test cases from qTest.
  5. Complete Setup: After configuring all the necessary settings and enabling the desired tools, click the arrow icon (located at the top right of the toolkit configuration section) to finalize the qTest toolkit setup and return to the main Agent configuration menu.
  6. Click Save in the Agent configuration to save all changes and activate the qTest toolkit integration for your Agent.

Tool Overview: qTest Toolkit Functionalities

Once the qTest toolkit is successfully configured and added to your Agent, you can leverage the following tools within your Agent's instructions to enable intelligent interaction with your qTest projects and test assets:

Instructions and Prompts for Using the qTest Toolkit

To effectively utilize the qTest toolkit within your ELITEA Agents, you need to provide clear and precise instructions within the Agent's "Instructions" field, telling the Agent how and when to use these tools.

General Instruction Structure:

When instructing your Agent to use a qTest tool, you will typically follow this pattern:

Use the "[tool_name]" tool to [describe the action you want to perform] in qTest.
Provide the following parameters:
- Parameter 1: <value or description of value>
- Parameter 2: <value or description of value>
- ...

Example Agent Instructions for qTest Toolkit Tools:

Important Considerations for Agent Instructions:

Best Practices and Use Cases for qTest Integration

Best Practices for Efficient Integration

Use Cases for qTest Toolkit Integration

The qTest toolkit opens up a wide range of automation possibilities for test management, QA workflows, and reporting within ELITEA. Here are some compelling use cases:

Troubleshooting and Support

Troubleshooting Common Issues

FAQs

Support and Contact Information

If you encounter any issues, have questions, or require further assistance beyond what is covered in this guide regarding the qTest integration or ELITEA Agents in general, please do not hesitate to contact our dedicated ELITEA Support Team. We are here to help you resolve any problems quickly and efficiently and ensure you have a smooth and productive experience with ELITEA.

How to Reach ELITEA Support:

Best Practices for Effective Support Requests:

To help us understand and resolve your issue as quickly as possible, please ensure you provide the following information in your support email:

Before Contacting Support:

We encourage you to first explore the resources available within this guide and the broader ELITEA documentation. You may find answers to common questions or solutions to known issues in the documentation.

To further enhance your understanding and skills in integrating qTest with ELITEA, here are some helpful resources: