/
14. Xray Integration

14. Xray Integration

Subject7 can be used to integrate with Xray which allows you to sync a Subject7 test case with an Xray Test Key and Test Plan whereby you will see different Test Runs and Test Executions in Xray for each execution started in Subject7.

  1. Hover over Administration menu and click Project Management

    image-20250411-110442.png

  2. Click Integrations tab. You will see the following options:

    image-20251119-142547.png

  3. Select between Cloud or Data Center depending on your instance. If you selected Data Center, you will need to enter a Data Center URL and Personal Access Token.

    image-20251120-111042.png

  4. If you selected Cloud, you will need to enter a Client ID and a Client Secret.

    image-20251120-111125.png

Cloud Setup Instructions

  1. On JIRA, click the Gear icon and navigate to Marketplace apps

    image-20251119-163503.png

  2. Under Xray, click API Keys on the left panel and click Create API Key on the top right.

    image-20251119-163603.png

  3. Select the username and click Generate

    image-20250411-111556.png

  4. The Client ID and Client Secret will be generated, copy each of them

  5. Back on the platform, click Enabled to allow using the input boxes and paste the Client ID and Client Secret.

  6. Select the Data Residency Region where your Xray is in. For more info, check this link

  7. Once finished, click Test Integration to ensure that it works, then click Save.

    image-20251119-142331.png

  8. Click Integration Settings to confirm additional options if you wish to do so.

  9. The Subject7 Default Config updates the Description field in Xray but you can add your own configuration of fields by clicking Add Configuration on the top left.

    image-20251119-164836.png

  10. Add the project key which is essentially the Space Key, then click Create Jira Project Configuration

    image-20251119-165025.png
    image-20251119-165105.png

  11. Click the configuration on the left side to edit it

    image-20251119-165140.png

  12. In the General tab, you can choose to Sync Step Results between Subject7 and Xray. This will automatically fill the steps in your Xray test to match the captions of your Subject7 test case. For example:

    image-20251120-102727.png

  13. In the Fields tab, you can click Add field which will allow you to customize the fields in Xray and pre-fill them with specific values.

    image-20251120-102813.png

  14. The example below is used to update the Label, the Due Date and a custom field created in Xray that we called Subject7:

    image-20251120-103037.png

 

Result:

image-20251120-103301.png

  1. To add your custom field ID, you can go to Gear icon > Work Items.

    image-20251120-104242.png

  2. Then click Fields and create a new field

  3. Once finished, click 3 dots next to it and click Contexts and default values

    image-20251120-104350.png

  4. The number will be displayed in the URL. Copy it and use it in customfield_number (as shown in step 14 above)

    image-20251120-104426.png

  5. To troubleshoot whether the above will work or not, you can click the Troubleshooting button highlighted below which will show you any errors if the Field ID is incorrect.

    image-20251120-103448.png

  6. You can troubleshoot by entering a sample Test Case Ticket Key and Test Plan Ticket Key from Xray as follows then click Create Sample Test Execution button:

    image-20251120-103536.png

  7. If the configuration has an issue, you will see a response to explain what went wrong. For example:

    image-20251120-104750.png
    { "error" : "Error creating Test Execution - Issue create failed! - customFieldId_10058: Field 'customFieldId_10058' cannot be set. It is not on the appropriate screen, or unknown." }

 

Using Xray Integration In Cloud Execution

 

In order to use Xray Integration in Cloud Execution, you will need to add your Xray Test Case Key and Test Plan Key as follows:

  1. Navigate to the Subject7 test case you would like to link to an Xray test case and click Configure Integrations button. The following window will appear:

image-20250411-111903.png

  1. Enter the XRay Test Case Ticket Key and click Save. For example, the below icons represent Test Case Ticket Keys

image-20250411-112027.png

  1. Save your test case.

  2. Hover over Executions menu and click Execution Sets

    image-20250411-112156.png

  3. Create an execution set and select the test case you created earlier. Refer to https://subject7.atlassian.net/wiki/spaces/SD/pages/40468511 if you would like to know more about creating execution sets.

    image-20251119-142409.png

  4. Switch back to General Setup tab and fill out the name of the set and select the pool.

  5. (OPTIONAL) Click Configure Integrations and enter the Xray Test Plan Key under which the Test Case Key exists. In step 2 for example, the Xray Test Plan Key is XRAY-1

    image-20251119-142436.png

  6. If you’d like to schedule the set, add a Schedule under Scheduling section.

  7. Save your execution set and click either Start Schedule or Cloud Run from the toolbar.

    image-20250411-112719.png

  8. After execution finishes, a test execution will be created on Xray to indicate one of the below statuses:

    1. Queued - Xray: ToDo

    2. Completed/Failed - Xray: Failed

    3. Completed/Error - Xray: Failed

    4. Completed/Passed - Xray: Passed

    5. Completed/Fail_Skip - Xray: Passed

  9. Back on Xray, open the test case and click Test Runs button

    image-20251120-105046.png

  10. You will see that an execution was added with an id that matches the generated one in Subject7, while the Sample Execution refers to any execution performed in Project Management (step 22 in the above section).

    image-20251120-105128.png

     

     

    image-20251120-105233.png

  11. To see more details, click on the Key which opens the Xray Test Execution

    image-20251120-105300.png

  12. If you used datasets in Subject7, they will be displayed by clicking Dataset icon in the Xray test execution. It will also show you additional information such as the Logs File URL, the Video URL, Browser name and Test Execution ID.

    image-20251120-105333.png

     

     

    image-20251120-105433.png

  13. You can also find the same information by clicking on the View Execution button

    image-20251120-105457.png

  14. In the Comment section, you can find the test case artifacts (video, image and logs) while in the Parameters section, you can find the dataset information (same as in step 15)

    image-20251120-110206.png