Skip to main content
All CollectionsAtlassian Jira - Technical Guides
Xray Configuration Guide for the AI Test Case Generator for Jira
Xray Configuration Guide for the AI Test Case Generator for Jira

The Xray Configuration Guide is a detailed resource that provides step-by-step instructions and best practices for setting up Xray.

Updated over 7 months ago

1. Navigate to the 'AI Test Case Generator - Project Settings' via the 'Apps' section in the left navigation menu of your project.

2. In the Integrations section, click the ‘Enable’ link on ‘Xray’.

3. Select 'Test’ as Xray Issue Type.

4. Generate credentials by clicking the 'API Credentials' link.

5. Click “Create API Key” button. Search for the user and click 'Generate' button.

6. Copy and paste the generated API keys to the corresponding Xray Integration fields (API Client ID, API Client Secret). Then, click 'Save'.

Users can save the test cases in a company-managed or team-managed project.

Company-Managed Project Configuration

1. In the sidebar of your company-managed project, go to 'Project Settings', then choose 'Apps' and select 'Xray settings'.

2. Click ‘Add Xray Issue Types' in the ‘Summary’ page.

3. After the Xray settings for company-managed project is configured, the user can go back to the project where user stories are located.

4. Navigate to 'Project Settings' in the sidebar, then under ‘Apps’, select 'AI Test Case Generator'.

In the AI Test Case Generator – Project Settings, select the ‘Company-Managed Project’ to save your test cases.

5. Select the 'Test (Xray Integration)' as Issue Type.

6. In the Xray Integration section, the user has the option to select the checkboxes.

  • Create Xray test cases in subfolders named after the epic

  • Create Xray test cases in subfolders named after the story

By selecting either or both checkboxes, the generated test cases will be stored in a subfolder named after the epic or story. To ensure the subfolder named after the epic is created, the user story must be linked with the epic; otherwise, despite being checked in the settings, it won't be created.

Once the 'Xray Global Configuration', ‘Xray Settings’ and 'Project Settings' are properly set up, users can smoothly generate test cases using AI Test Case Generator.

Team-managed Project Configuration

1. In the sidebar, navigate to Project Settings and select ‘Issue types.'

2. Create the issue type by clicking 'Add Issue Type'. Users can enter the issue type name and select icon.

3. Click the 'Create' button.

4. Navigate back to Project Settings, then select ‘Xray Settings’ under ‘App’.

5. In the ‘Issue Types Mapping’, select your created issue type under ‘Test’. Click 'Save'.

6. After the Xray settings for company-managed project is configured, the user can go back to the project where user stories are located.

7. Navigate to 'Project Settings' in the sidebar, then under ‘Apps’, select 'AI Test Case Generator'.

In the AI Test Case Generator – Project Settings, select the Team-Managed Project’ to save your test cases and the issue type configured in Xray settings. Make sure to tick the 'Use Xray Integration’ checkbox.

8. In the Xray Integration section, the user has the option to select the checkboxes.

  • Create Xray test cases in subfolders named after the epic

  • Create Xray test cases in subfolders named after the story

By selecting either or both checkboxes, the generated test cases will be stored in a subfolder named after the epic or story. To ensure the subfolder named after the epic is created, the user story must be linked with the epic; otherwise, despite being checked in the settings, it won't be created.

Once the 'Xray Global Configuration', ‘Xray Settings’ and 'Project Settings' are properly set up, users can smoothly generate test cases using AI Test Case Generator.

Xray Test Case Generation Process

The same process applies if the user selects a company-managed or team-managed project in the Project settings.

1. Navigate back to your project and select the user story. Within the user story, the 'Generate Test Cases' button will appear after clicking on 'AI Test Case Generator' located below the user story summary.

2. Click the ’Generate Test Cases’ button and wait until the processing is completed.

3. Check the generated test cases linked in the user story.

Sample test case generated by the 'AI Test Case Generator'.

The generated test cases can be stored in a company-managed or team-managed project selected in the project settings. Each test case includes test case number, summary, description, precondition and priority.

4. Click 'Test Details’ below the test case summary or scroll down to ‘Test Details' section to view the test steps.

Users can also view the generated test cases in your selected project configured in the Project settings.

5. In the project sidebar, navigate to ‘Testing Board’, the generated test cases are also available. By clicking the test case issue key, the test case details will be visible.

Since we have selected the Xray subfolder checkboxes in the 'AI Test Case Generator Project Settings', the generated test cases are stored in a subfolder named after the user story, which is located within another subfolder named after the epic.

If the checkboxes are not selected in the settings, the test cases will be stored in the ‘Test Repository’.

6. Users have the option to modify the folder name by right-clicking and selecting 'Rename Folder’.

7. Update the folder name and click ‘Rename’

8. The new folder name will be reflected.

Re-generating Test Cases

Users can re-generate test cases if there are changes to the requirements.

1. Navigate back to the user story with existing test cases.

2. Click ‘Re-Generate Test Cases’ button. If the user opts to select the checkbox for deleting existing test cases during re-generation, the existing test cases will be replaced with a new set.

3. If the checkbox remains unselected, the existing test cases will be retained, and new test cases will be generated and linked to the user story.

The repository will also be updated.

Bulk Generation of Xray Test Cases

1. In your project sidebar, navigate to ‘Bulk AI Test Case Generator’.

2. Users can select the user stories by 'Sprint' or ‘Advanced Search’.

3. Select the user stories.

4. In Bulk generation, users have the option to select the checkbox 'Create a parent bulk operation folder for Xray issues’. If the checkbox is ticked, a parent bulk operation folder will be created for the test cases.

5. Click ‘Generate Test Cases’. Please be patient while the app is linking the Xray test cases and wait until the processing state is ‘Complete’.

6. Xray test cases should be generated for all the selected user stories during the bulk process.

7. Navigate to the ‘Testing Board’ of your company-managed or team-managed project.

A parent bulk operation folder is created since we have selected the checkbox to create a parent bulk folder.

Unlinking of Xray Test Cases

1. Navigate to your project board and select the user story with existing test cases.

2. In the user story, scroll down to ‘Linked issues’ section.

3. Hover over the test cases that you want to unlink in the story.

4. Click on the ‘Unlink issue’ or ‘x’ beside the test case status. A confirmation popup to remove the test case will be displayed.

5. Click ‘Remove’ in the popup, and the test case should be unlinked from the user story.

Deleting Xray Test Cases

1. Navigate to the project where your test cases are located. In the sidebar, go to the ‘Testing Board’.

If the test cases that you want to delete are still linked in the user story, users can easily display the test case by clicking the link.

2. Select the test case by clicking the test case ‘issue key’.

3. Click on the ellipsis menu located at the top right section of Jira.

4. Click ‘Delete’ if you are sure about permanently deleting the test cases. Otherwise, click ‘Cancel’.

After successful deletion, the test case is permanently deleted from this project.

Did this answer your question?