---
title: "Xray Test Management for Jira"
canonical: "https://docs.getxporter.app/space/XPORTERCLOUD/526612/Xray%20Test%20Management%20for%20Jira"
format: markdown
---
> Macro (rw-ui-expands-macro)
> 
> > Macro (rw-expand)
> 
> > Macro (toc)

# Introduction

[Xporter for Jira Cloud](https://marketplace.atlassian.com/apps/891368/xporter-export-issues-from-jira?tab=overview&hosting=cloud) integrates with [Xray Test Management for Jira](https://marketplace.atlassian.com/apps/1211769/xray-test-management-for-jira?tab=overview&hosting=cloud). Xray is a Jira test management tool that supports the entire testing life cycle: test planning, design, execution, and reporting.

This Xray integration (Figure 1 - 1) allows you to export information including:

- [Precondition](https://docsxporter.atlassian.net/wiki/spaces/XPORTERCLOUD/pages/430551)[s](https://docsxporter.atlassian.net/wiki/spaces/XPORTERCLOUD/pages/430551).
- [Test](https://docsxporter.atlassian.net/wiki/spaces/XPORTERCLOUD/pages/560236)[s](https://docsxporter.atlassian.net/wiki/spaces/XPORTERCLOUD/pages/560236).
- [Test Execution](https://docsxporter.atlassian.net/wiki/spaces/XPORTERCLOUD/pages/560192)[s](https://docsxporter.atlassian.net/wiki/spaces/XPORTERCLOUD/pages/560192).
- [Test Plan](https://docsxporter.atlassian.net/wiki/spaces/XPORTERCLOUD/pages/528621)[s](https://docsxporter.atlassian.net/wiki/spaces/XPORTERCLOUD/pages/528621).
- [Test Set](https://docsxporter.atlassian.net/wiki/spaces/XPORTERCLOUD/pages/462023)[s](https://docsxporter.atlassian.net/wiki/spaces/XPORTERCLOUD/pages/462023).

![Figure 1 - Xray integration](media://3b152931-64cc-42e9-81be-9a7fb7ee0116)

# Using Xray Test Management for Jira

## Setup Integration

Before using the Xray [mappings](https://docs.getxporter.app/space/XPORTERCLOUD/558575), you need to set up the Xray Test Management for Jira integration.

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> On your Jira Cloud instance, click *Settings*/gear icon (Figure 2 - 1) and select *Apps *(Figure 2 - 2). The Xray menu will open on the left side of the screen (Figure 2 - 3). There, click *API Keys* (Figure 2 - 4).
> 
> ![Figure 2 - Apps](media://1c9f8faa-c7f4-4399-8e28-84c9811191c3)
> 
> > Macro (rw-step)
> 
> Click the *Create API Key* button (Figure 3 - 1). A modal will open for you to select a user (Figure 3 - 2; this user must have administrator access). Then, click the *Generate* button (Figure 3 - 3).
> 
> ![Figure 3 - API Key](media://57ec2936-9f41-4dab-9088-76085d669b6b)
> 
> You will see a message confirming the API key creation (Figure 3 - 4).
> 
> Copy the Client ID (Figure 3 - 5) and Client Secret (Figure 3 - 6) and close the modal (Figure 3 - 7).
> 
> > Macro (rw-step)
> 
> Go to the Xporter menu (Figure 4 - 1) and click *Integrations* (Figure 4 - 2). On the Xray integration, click the *Configure* button (Figure 4 - 3). A modal will open.
> 
> ![Figure 4 - Xray configuration](media://7af3d347-25fc-4143-a9bc-75425da45398)
> 
> Paste the Client ID (Figure 4 - 4) and the Client Secret (Figure 4 - 5) you copied from step 2, and click the *Configure* button (Figure 4 - 6). You will see a success message confirming the configuration of the Xray integration.
> 
> > ℹ️ The Xray integration setup is concluded.

## Exporting Xray Data

After setting up the Xray integration, you can export any Xray data from Jira:

- [Precondition](https://docsxporter.atlassian.net/wiki/spaces/XPORTERCLOUD/pages/430551)[s](https://docsxporter.atlassian.net/wiki/spaces/XPORTERCLOUD/pages/430551).
- [Test](https://docsxporter.atlassian.net/wiki/spaces/XPORTERCLOUD/pages/560236)[s](https://docsxporter.atlassian.net/wiki/spaces/XPORTERCLOUD/pages/560236).
- [Test Execution](https://docsxporter.atlassian.net/wiki/spaces/XPORTERCLOUD/pages/560192)[s](https://docsxporter.atlassian.net/wiki/spaces/XPORTERCLOUD/pages/560192).
- [Test Plan](https://docsxporter.atlassian.net/wiki/spaces/XPORTERCLOUD/pages/528621)[s](https://docsxporter.atlassian.net/wiki/spaces/XPORTERCLOUD/pages/528621).
- [Test Set](https://docsxporter.atlassian.net/wiki/spaces/XPORTERCLOUD/pages/462023)[s](https://docsxporter.atlassian.net/wiki/spaces/XPORTERCLOUD/pages/462023).

> ℹ️ ### Xray Integration Limitations
> ℹ️ 
> ℹ️ - It's not possible to get the tests' requirement status.
> ℹ️ - Cloud apps aren't able to create [JQL Functions](https://docs.getxporter.app/space/XPORTERCLOUD/527003). Templates aren't fully compatible between Data Center/Server and Cloud hosting. Please, check the new templates for this integration in the [Xporter Template Store](https://store.getxporter.app/).
> ℹ️ 
> ℹ️ We expect to deliver these features soon.

  


<details>
<summary>Support/Troubleshooting</summary>

If you have questions or technical issues, please [contact the Support team via the Customer Portal (Jira service management)](https://jira.getxray.app/servicedesk/customer/portal/2/user/login?destination=portal%2F2%2Fcreate%2F28) or [send us a message using the in-app chat](https://docs.getxporter.app/space/XPORTERCLOUD/18251779/In-App+Chat+Support).
</details>