QAComplete Integration

Applies to ReadyAPI 3.52, last modified on April 25, 2024

ReadyAPI seamlessly integrates with QAComplete – a comprehensive test management tool provided by SmartBear Software.

About QAComplete

QAComplete boosts your testing capabilities by helping you to:

  • Organize and track the testing process from start to finish.

  • Plan, understand and manage tests to make better release conditions.

  • Get insight into requirements traceability and test case status within and across releases.

  • Report and track defects using built-in defect management.

To learn more about QAComplete and its features, and to try out its functionality, visit qacomplete.com.

Install plugin

To install the integration plugin:

  1. Open the Integrations tab.

  2. Find the QAComplete integration and click Install.

Requirements and limitations

To work with the integration plugin, you need to use:

QAComplete SaaS

— or —

QAComplete Server 11.6 or later

With the integration plugin, you can remotely create QAComplete items – that is, database records – within your QAComplete instance. Currently, the plugin supports only the default QAComplete settings. The following features are not supported:

  • Custom fields
  • Custom and modified choice lists
  • Non-default required fields

Prepare integration

To start using the integration, make sure it has been configured properly:

  • Check whether the QAComplete integration is in the right part of the Integrations tab.

  • Open the Preferences dialog. On the QAComplete tab, specify the connection settings for your QAComplete instance:

    Preferences: The QAComplete tab

    Click the image to enlarge it.

    Option Description
    REST API URL The URL you use to connect to the REST API of your QAComplete instance.
    • For SaaS users: https://rest.qacomplete.smartbear.com/rest-api/service/api
    • For on-premises users: http://<your server>/rest-api/service/api
    Make sure to specify the protocol you use to connect to the server – HTTP or HTTPS.
    E-mail The email address you want ReadyAPI to use to log in to the QAComplete instance.
    Password The password you want ReadyAPI to use to log in to the QAComplete instance.
    Returned items limit Specifies how many items ReadyAPI should retrieve at a time. Used when creating automations – see below.
    Create tests with automations If selected, ReadyAPI automatically adds automation to all newly created QAComplete tests.

Create items in ReadyAPI

Once the integration plugin has been properly configured, you can use it to create new items in your QAComplete instance. To call the integration dialog, select any item in the Navigator, then click QAComplete on the ReadyAPI toolbar.

ReadyAPI toolbar: The QAComplete button

Click the image to enlarge it.

The Create Item dialog will appear.

The Create Item dialog

In the Project drop-down list, select the QAComplete project that will store your new item. In the Item Type drop-down list, select the type of the item you want to create.

Currently, you can use the integration to create defects, tests, and automations.

To create a defect:

  1. Select Defect in the Item Type drop-down list of the Create Item dialog.

  2. Click OK.

  3. In the subsequent Create Defect in Project dialog, describe the defect you want to create. Each edit box and drop-down list corresponds to a field in the database of your QAComplete instance.

    The Create Defect in Project dialog

    Click the image to enlarge it.

    Field Description
    Title Required by default. A comprehensive title for the new defect.
    Folder The folder you want to store the new defect in.
    Status Required by default. The status of the defect.
    Priority The priority of the defect.
    Assigned to The QAComplete user you want to fix the defect.
    Description Required by default. The description of the defect.
    Steps to reproduce A list of actions one needs to take to see the defect themselves.
    Resolution code The resolution code of the defect.
    Resolution Arbitrary text describing how the defect has been resolved.
    Expected Result Arbitrary text describing the results the user expected.
    How found How the defect was encountered.
    Issue The type of the defect – a bug, a code issue, and so on.
    Severity The severity of the defect.
    Actual Result Arbitrary text describing the actual results.
    Attach project If selected, adds the ReadyAPI project file to the newly created defect as an attachment.
    Attach ReadyAPI log If selected, adds the ReadyAPI log to the newly created defect as an attachment.
    Attach file Any extra file you want to attach to the new defect. Click Browse to navigate to the file on your machine.

  4. Click OK.

  5. ReadyAPI will create the new defect in your QAComplete instance.

    If it is created successfully, a dialog containing brief information on your new defect and a link to its Edit form in the QAComplete instance will appear.

    The New Defect dialog

To learn more about QAComplete defects and how to work with them, see the QAComplete documentation.

To create a test:

  1. Select Test in the Item Type drop-down list of the Create Item dialog.

  2. Click OK.

  3. In the subsequent Create Test in Project dialog, describe the test you want to create. Each edit box and drop-down list corresponds to a field in the database of your QAComplete instance.

    The Create Test in Project dialog

    Click the image to enlarge it.

    Field Description
    Title Required by default. A comprehensive title for the new test.
    Folder The folder you want to store the new test in.
    Status Required by default. The status of the test.
    Priority The priority of the test.
    Assigned to The QAComplete user you want to assign the test to.
    Description Arbitrary text describing the test.
    Active test Defines whether the new test should be active in QAComplete, that is, whether it should be available in the Test Library and for test runs.
    Execution type The execution type of the new test.
    Test type The type of the new test – a regression test, smoke test, and so on.
    Attach project If selected, adds the ReadyAPI project file to the newly created test as an attachment.
    Attach ReadyAPI log If selected, adds the ReadyAPI log to the newly created test as an attachment.
    Attach file Any extra file you want to attach to the new test. Click Browse to navigate to the file on your machine.

  4. Click OK.

  5. ReadyAPI will create the new test in your QAComplete instance.

    If it is created successfully, a dialog containing brief information on your new test and a link to its Edit form in the QAComplete instance will appear.

    The New Test dialog

To learn more about QAComplete defects and how to work with them, see the QAComplete documentation.

Tests with automations

You can configure the plugin to automatically add your ReadyAPI project as automation to the newly created QAComplete tests. To do that, select the Create Tests With Automations check box in Preferences > QAComplete.

If this option is enabled, the Create Automation dialog will appear automatically after a new test is created successfully.

Before creating automation, make sure you have saved your project, since ReadyAPI will not be able to zip it if it is not present on the hard drive.

To create automation:

  1. Select Automation in the Item Type drop-down list of the Create Item dialog.

  2. Click OK.

  3. The Create/Update Automation dialog will appear.

    The Create/Update automation dialog

    Click the image to enlarge it.

    In the Test drop-down list, select an existing QAComplete test.

    The plugin retrieves a list of tests automatically when you open this dialog. You can specify the number of tests you want to retrieve in Preferences – see above.

  4. In the Automation drop-down list, choose whether you want to add new automation (the <Create New> option) or replace an existing one.

  5. Click OK.

  6. In the subsequent Create Automation dialog, specify additional information about the automation you want to create. Each edit box and drop-down list corresponds to a field in the database of your QAComplete instance.

    The Create Automation in Test

    Click the image to enlarge it.

    Field Description
    Title Required by default. A comprehensive title for the new automation.
    Timeout (min.) Required by default. A timeout for running the new automation. If the test takes longer than the given timeout, the QAComplete Test Runner will stop running.
    Report Type Required by default. The type of the report you want ReadyAPI to generate for this automation.
    Test suite The ReadyAPI test suite you want to run in this automation. To run all the test suites of your project, leave the edit box blank.
    Test case The ReadyAPI test case you want to run in this automation. If you leave the edit box blank, the QAComplete Test Runner will execute all the test cases of the specified test suite, or, if you have not specified a test suite, all the test cases of your project.
    Custom arguments The custom arguments you want to pass to the ReadyAPI test runner in this automation.
    Run mode Defines whether to run this automation in a separate folder, or whether to use your project (in-place run).

  7. Click OK.

  8. ReadyAPI will try to add the new automation to the test in your QAComplete instance.

    If it is added successfully, a dialog containing brief information on your new automation and a link to its Edit form in the QAComplete instance will appear.

    The New Automation dialog

To learn more about ReadyAPI test automations in QAComplete and how to work with them, see the QAComplete documentation.

See Also

QAComplete Documentation
Integrations

Highlight search results