After installing Xray, there are basically two steps you need to make or ensure before starting to use it.


Configure Requirements and Defects

In Jira's administration, in the Add-ons tab,  go to Issue Type Mapping and configure what issue types should be considered as "requirements" and "defects".


Xray Issue Types (Test, Test Plan, Test Set, Test Execution, Sub-Test Execution and Precondition) MUST NOT be mapped as Requirements nor Defects.


Learn more

Refer to the specific Issue Type Mapping page or take a look at the extensive Administration & Configuration if you want to fine-tune Xray or adapt it to your specific needs.


Enable Xray in your projects

You can enable Xray for your existing projects or create a new project with both standard and Xray issue types.

Enable testing in existing projects

For existing projects, in the project Administration page, go to Actions at the top right-hand side. You can either:

a) set your project as a Requirements project by choosing "Enable Xray Requirement Coverage", so the requirements are covered by tests; or

b) add Xray issue types (i.e., Test, Test Set, Test Execution, Test Plan) to the project.


Please note

Since the Issue Type Scheme being used by your project may also be used by other projects, in order to add Xray's Issue Types from the project settings page you must belong to a group allowed to do so in Xray settings. The allowed groups to add Xray Issue Types can be defined in this setting.




Create new projects from scratch with testing enabled

If, instead, you want to quickly create a new project and use it to manage everything (e.g., requirements, defects, tests), go to the Jira Administration page for Projects. In the creation dialog, choose "Xray Test Project".





Configure Test Case Designer


Test Case Designer is a cloud powered feature and requires user to make an initial configuration to allow access.


Step 1 - Create a new Application Link


  • Head to Jira Administration → Applications → Integrations → Application Links
  • Select "Create link";
  • On the popup window select "External application" on the Application type and "Incoming" on the Direction options;
  • Click "Continue";
  • On the "Configure an incoming link" fill in:
  • Click "Save"

Step 2 - Share the Application link credentials with Xray Support


  • On the created Application link, select the action "View credentials" from the dropdown.
  • On the credentials screen, copy the "Client ID" and "Client secret"


  • Send an email to support@getxray.app  or create a support ticket with the title “New Enterprise Support users” with the following information:

    • Client ID

    • Client secret

    • Your Jira Server URL

    Our support team will then initialize your organization and share back your Xray Test Case Designer custom URL.

Step 3 - Configure the Xray Test Case Designer custom URL


  • After receiving the Custom URL, from our support team, just head to Administration → Manage Apps → Xray → Xray Enterprise


  • Fill in the "Custom URL" field with the link provided.
  • Click "Save"


You will now be able to see the new option on projects menu for Test Case Designer