Menu

Integration with VersionOne

Overview

qTest Manager's integration with VersionOne allows for teams to see full traceability between test runs, VersionOne requirements, and defects.

qTest Manager currently supports integration with VersionOne OnDemand for submitting Defects to VersionOne and import Requirements from VersionOne.  You can add as many connections with VersionOne OnDemand but only one connection is active at a time.

How to Get Here

  1. In the Project you are integrating with VersionOne, select the Gear icon and choose Integration Settings.
  2. Select VersionOne in the External Systems section and the Configure Integration page loads.
  3. Select the Add VersionOne Connection button.

Setting up the Connection

There are two methods to configuring your connection:

  • VersionOne without SSO enabled
  • VersionOne with SSO enabled

VersionOne without SSO enabled

  1. In the Add VersionOne Connection dialog, enter the required information for the connection:
    • Connection Name
    • V1 Server URL
    • V1 Account Credentials

  2. Select the Test Connection icon to check the server availability.
  3. Select the Save & Configure icon after a successful connection test.
  4. Now, you can configure the integration with V1 for defects and requirements.
  5. For a new Connection, the "Configure Connection" Page will display after you select Save & Configure.
  6. For an existing Connection, select the Configure icon of that connection to open the "Configure Connection" Page.
  7. After configuring Defect and Requirement integration, select Save & Activate.
  8. Select Refresh on the "Confirmation" dialog. Your newly configured connection will be activated. The Activation Status is On and your configured connection is checked as Active in the Connection List.
  9. After your V1 Connection integration is successfully activated, it will be notified with a green status label "in use" next to VersionOne (On-demand), and the Defect menu will be hidden. Thus, the only way to submit a defect is through Test Execution.

  10. To edit your connection, select the Configure icon of that Connection in the Connection List.
  11. You can delete your V1 connection in the Connection List by selecting the Delete icon in the Actions column.

 

VersionOne with SSO Enabled

Read these instructions on how to generate a VersionOne access token before attempting to establish a connection with SSO. 

  1. In the Add VersionOne Connection dialog, enter the required information for the connection:
    • Connection Name
    • V1 Server URL
    • Username=apikey
    • Password=VersionOne access token
      version_one_with_SSO.png
  2. Select the Test Connection icon to check the server availability.
  3. Select the Save & Configure icon after a successful connection test.
  4. You can start to configure integration with V1 for defects and requirements.
  5. For a new Connection, the "Configure Connection" Page will display after you select Save & Configure.
  6. For an existing Connection, select the Configure icon of that connection to open the "Configure Connection" Page.
  7. After configuring Defect and Requirement integration, select Save & Activate.
  8. Select Refresh on the "Confirmation" dialog. Your newly configured connection will be activated. The Activation Status is On and your configured connection is checked as Active in the Connection List.
  9. After your V1 Connection integration is successfully activated, a green status label of "in use" appears next to VersionOne (On-demand) in the External Systems panel. Additionally, the Defect tab will be hidden in Manager. Thus, the only way to submit a defect is through Test Execution.

Connection Maintenance

  1. To edit your connection, select the Configure (wrench) icon of that Connection in the Connection List.
  2. You can delete your V1 connection in the Connection List by selecting the Delete icon in the Actions column.

Configuring Defects with VersionOne

After you successfully set up the connection with your V1 OnDemand instance, you can set up defect integration.

IMPORTANT:

  • You can set integration with multiple V1 projects.
  • You can select multiple V1 object types to map as qTest Manager Defects.
  • qTest Manager requires you to have at least one project and object type selected.
  • Mapped V1 objects will be treated as Defects in qTest Manager.

To configure Defects Integration with V1

  1. Go to the Configure Connection screen after a successful Connection Set-up.
  2. In Defect Integration, select Add Defect Type.

  3. Select VersionOne Project and VersionOne Object type from the drop-down lists.

  4. In the Action column of the Defect Integration's Mapping list, select the Configure icon to configure individual mapped Defects.
  5. The Edit Auto-Filling form displays. By default, qTest Manager will load all available fields of the mapped V1 object type onto the Defect Field column.
    • Select Reset Fields to reload the latest Field Settings of the mapped object type.
    • Select the Repopulate icon in the Action column of each Defect field to reload the latest values of individual fields from V1.
    • Select the Delete icon to remove the display of specific fields from the qTest Manager defect submission form.  Those deleted fields are still on the V1 form.
    • Use the Move Up and Down arrows to re-arrange the display of defect fields in the qTest Manager defect submission form.  Their positions remain unchanged in the V1 form.
    • Select the Add Field button to manually add fields that can't be automatically populated from V1 to qTest Manager.

    Edit_Auto_Filling_Form.png

Set Auto-Filling for mapped V1 object type's fields.  qTest Manager will auto-fill data from Test Run or Test Case into the mapped V1 object's field as settings.

  • Select a defect field to open the Edit Field Screen.

    Select_Defect_Field_for_mapping.png

  • Edit the field as your own style, such as required or field type.
  • Check the Auto Fill option in Input Option or you can set Default Value for field.
  • Select the Add icon to add a field for mapping.
  • Select the Drop-down icon to select a qTest Manager field to map to V1 field.
  • Select the OK icon to finish your mapping configuration.

Add_Auto-Fill_Value.png

HINTS:

  • The values of mapped input and output fields must be symmetric between V1 and qTest Manager.
  • Only fields in Text format can be auto-filled.
  • You can select to fill multiple qTest Manager fields into one V1 field.

Retrieving Requirements from VersionOne

Configure Requirement Integration with VersionOne

Users can optionally turn the Requirement Integration feature on to retrieve V1 objects and import into qTest Manager as Requirements.

To configure, follow these steps:

  1. Turn ON the Requirement Integration feature to activate.
  2. Select the Add Requirement Type button.

  3. The Add Issue Types modal displays.
    • Select the down-arrow to the right of The VersionOne project field to expand the drop-down list. Select the applicable VersionOne project from which you will import requirements to qTest Manager.
    • Select the down-arrow to the right of the VersionOne Object types field to expand the drop-down list. Select the object type you use to represent requirements in the VersionOne project selected above (e.g., story, feature, epic, task, work item). This procedure will retrieve that object type, so it is imported into qTest Manager as Requirements.


      HINT: The purpose of this step is to identify the object type from the VersionOne project and import that object type into qTest Manager as Requirements.

  4. Select OK to save, and a line item is now visible in the Requirement Integration area of the Configure Connection page. 
    Details include:
    • the name of the VersionOne Project you selected
    • the associated VersionOne object type you selected

Edit Data Retrieval

Now, you need to edit how qTest is going to retrieve your VersionOne data.

  1. Position the cursor into the ACTION column, of the new line, that indicates the VersionOne Project and VersionONe Object Types you want to edit the data retrieval. Three icons are displayed but select the middle icon, the wrench.
  2. The Edit Data Retrieval screen loads and you can configure three things, (more information is provided in the sections below.)
    • Establish how requirements from VersionOne will be organized, based on one or two VersionOne fields.
    • Select the VersionOne fields you wish to display in qTest Manager.

Organize into Folder Structure

By default, the Requirements from JIRA are imported into one 'Imported from VersionOne' folder in qTest Manager, resulting in a flat structure.

We do not recommend using this default structure for Requirements.
flat_requirements.png

Therefore, you can organize your imported Requirements, using up to two VersionOne Object fields, which results in a nested folder structure below the standard 'Imported from VersionOne' folder.

The screenshot below shows a two-level structure of V1 requirements, meaning that your V1 object fields have been selected for organizing your Requirements. We strongly recommend using this structure for requirements.
folder_structure_requirements.png

To organize your Requirement folders, do the following:

  1. In the Select fields to organize imported Requirements section, select the arrow to the right of Field 1 and choose the desired V1 field in the drop-down list, such as Portfolio.  
  2. Select the arrow to the right of Field 2 and choose the desired JIRA Issue field in the drop-down list, such as Build.  

The steps above enable you to create a 2-level folder structure to help organize your imported requirements according to the two V1 object fields selected here.

NOTES:

  • If you select only one V1 object field to organize your Requirements folders, then you will have a one-level folder structure under the default Imported from V1 folder.
  • If you select a V1 object field for folder organization, that can have more than one assigned value in V1 (multi-selection), then the folder name that is created will include:
    • all values assigned to the Requirement of the selected V1 object field
    • and the values will be separated by a semicolon ' ; '  
      Example:
    • selected V1 object field = 'Component'
      • 'Component' values assigned to this V1 Requirement= Database and API
        • Folder name= Database;API

In the following example, the ‘Portfolio Item’ object has been selected in Field 1, and the ‘Build’ object selected in Field 2.
edit_data_retrieval.png

IMPORTANT: Using the integration, qTest Manager will
 poll V1 every two minutes to get the updated + new objects.  You have to Re-select, Reload, or Refresh to get the updated data of V1 objects you are standing on after the initial import (e.g., move requirement from In Progress to Done folder.)

Select VersionOne Fields to Display on Requirements

The V1 fields you select here will be accessible to testers for informational purposes. They display in the V1 Properties-Read Only section of the Requirement page in qTest. 

The following image shows multiple V1 fields displayed. We highly recommend using this approach.

version_one_read_only_properties.png

This image shows the bare minimum of fields displayed. We do not recommend using this approach.

To select the V1 fields to display on your Requirements, do the following:

  1. In the V1 ISSUE FIELDS section, select any additional data from V1 you want to import to qTest Manager, such as the Fix Version and Priority.
  2. To select a field, select the ACTIVE check-box for the item.  
    Note: We recommend checking all the checkboxes to import all of this data into qTest Manager.  
    HINT: For each qTest Manager Project, you can customize the V1 fields to show in the Requirements page of qTest Manager. The fields you use in one project may differ from the fields used in another project.
  3. Select OK and the Edit Data Retrieval modal closes.

Save and Activate the VersionOne Requirement Integration

  1. Once the Edit Data Retrieval modal closes, you MUST select the Save & Activate button (which is located at the top right) on the Configure Connection page.  
  2. The CONFIRMATION pop-up window displays.



  3. Select Refresh and the Configure Integration page displays. 
  4. Select the Retrieve VersionOne Data button. This is a manual process to kick off the integration connection to initially pull your data.
    retrieve_V1_data_button.png

  5. The EXTERNAL ISSUES RETRIEVING PROGRESS pop-up window displays. A progress bar is visible in the window.
  6. When qTest Manager has imported all V1 requirements, a confirmation message is displayed.
  7. Select OK. The requirements which were created in V1 will be accessible to testers in read-only form in qTest Manager. 
     
    HINT: You can retrieve data of all V1 object types or any specific types you map.
    • Select the Retrieve VersionOne Data icon to populate the latest data of all mapped V1 object types.
    • Select the Re-Populate icon to get the latest data of a specific mapped V1 object type.

    • In specific imported V1 imported Requirements in qTest Manager, select Retrieve data to reload the latest data of that V1 object.

View Imported VersionOne Requirements

Imported VersionOne objects will be treated as Requirements in qTest Manager.

By default, these integrated requirements will be loaded into a common Module folder named "Imported from VersionOne" as shown below.

large_scale_view_imported_requirements.png

IMPORTANT:

  1. Imported V1 objects are represented by special integration icons to differ from internal qTest Requirements.Snap_2013-08-02_at_11.30.36.png
  2. An imported V1 object has two Properties sections - VersionOne's Properties and qTest's Properties
    • V1's Properties contain Active V1 object fields configured on the Edit Data Retrieval screen.  These Properties are Read-only.  qTest Properties contain all qTest Manager Requirement's fields, excluding Description.
    • qTest Manager will poll V1 every two minutes to get the updated + new objects.  You have to Re-select, Reload, or Refresh to get the updated data of V1 objects you are standing on.
  3. Imported V1 objects can be copied or moved across Modules within a qTest Project to re-organize Module Structure.
    • Copied objects will become qTest Requirements which only retain the Description of V1 objects.
    • Moved objects' Properties will remain unchanged.
  4. Imported V1 objects can be associated to qTest Manager Test Cases.
  5. V1 IDs of imported objects will be included in the Requirements and Test Execution Results Report

HINT:

  • An object in V1 has two different types of ID - the display ID and the OID. Those IDs are displayed in qTest as shown below.

Linking Test Cases with VersionOne Requirements

Imported V1 objects can be linked to qTest Manager Test Cases. The linking with qTest Manager Test Cases will be generated in the corresponding V1 object's Links section.

  • When you link or create associated Test Cases to an Imported V1 object, qTest Manager also generates a link under the corresponding V1 object.

Submitting Defects to VersionOne

You can submit defects to V1 from qTest Manager during TestPad Execution or from the Test Log.

  1. Select the Bug icon linked to Test Steps or Submit Defect linked to a Test Run in the TestPad.

    Submit_Defect_to_Jira.png

  2. You can also select the Bug icon in the Execution History and Test Log Details sections to create defects.

  3. Select the New button to create a new Defect.
  4. Select one of the configured V1 object types to submit the Defect.
    • The Mapped Project will be attached before the Defect Type and auto displayed in the Project drop-down list, corresponding to the selected Defect Type.

  5. The Defect Submission form loads.
    • If you have the qTest Integration Browser Plugin installed, qTest Manager will open the VersionOne Defect form. You must log in before submitting defects.

    • If you DO NOT install the browser plugin, qTest Manager will open the qTest Defect Submission form with integrated fields from V1.

      Defect fields will be auto-filled as configured

  6. The system will return the Defect ID and Summary from VersionOne that is attached to the Bug icon.

    HINT:

    • An object in V1 has two different types of ID - the display ID and the OID.  Those IDs are displayed in qTest as shown below.

Review VersionOne Defect After Submission

From V1, you can see the link to the qTest Test Run in the Link section of the defect.

Review VersionOne Defects in Manager

In qTest Test Execution, you can find V1 defect information in many areas:

Test Run page:

  • To view V1 defects in a particular Test Log, select the defect icon from the Execution History grid.
  • For an aggregate list, select the Defects tab for a roll-up of all V1 defects related to any of the test logs of the Test Run. The Defects tab can be customized so you can display additional V1 Defect fields as columns. 

Test Suite, Cycle, and Release pages:

  • To view V1 defects for a single Test Run, select the Defect icon from the Test Run grid.manager_defect_single.png

  • For an aggregate list, select the Defect Summary tab for a roll-up of all V1 defects related to associated Test Runs. This Defect Summary tab can be customized so that you can display additional V1 Defect fields as columns. 
    manager_defect_list.png

For advanced reporting, use qTest Insights to gain more defect visibility. 

Powered by Zendesk