Configure Xray as a Source in your Pipeline

Perform the following steps to configure your Xray Source:

1. Click Pipelines in the Navigation Bar.

2. Click + Create Pipeline in the Pipelines List View.

3. On the Select Source Type page, select Xray.

4. On the Select Destination Type page, select the type of Destination you want to use.

5. In the Configure Source screen, specify the following:

   

   • Source Name: A unique name for your Source, not exceeding 255 characters. For example, Xray Source.

   • In the Connect to Xray section, specify the following:

     • Client ID: The Client ID of the API key that you created in Xray.

     • Client Secret: The Client Secret of the API key. You can change this value after the Pipeline is created.

6. Click Test & Continue to test the connection to your Xray Source. Once the test is successful, you can proceed to set up your Destination.

   When you click this button, Hevo checks that it can authenticate with Xray using the specified Client ID and Client Secret.

---

Data Replication

Hevo replicates data for all the objects selected on the Configure Objects page during Pipeline creation. By default, all supported objects and their available fields are selected. However, you can modify this selection while creating or editing the Pipeline.

Selecting a parent object automatically includes all its associated child objects for replication. Child objects cannot be selected or deselected individually. The Data Model lists the child objects of each parent object.

In the first run of the Pipeline, Hevo ingests all the data available for the selected objects in your Xray account. In the subsequent runs, as per the sync frequency, Hevo ingests data as follows:

Hevo ingests the child objects of a parent object along with it. When Hevo ingests a new or updated test, it replaces the steps and step attachments of that test in the Destination. Similarly, when Hevo ingests a new or updated test plan, test set, or test execution, it replaces the list of tests linked to it.

Xray enforces a rate limit of 60 calls per minute (300 calls per 5 minutes) for Xray Standard and 200 calls per minute (1000 calls per 5 minutes) for Xray Enterprise. The limit applies to each Jira instance. If this limit is exceeded, a rate limit exception occurs. To understand how Hevo handles such scenarios, read Handling Rate Limit Exceptions. For more information, read the Xray article on the Xray Cloud REST API limit.

Note: You can create a Pipeline with this Source only using the Merge load mode. The Append mode is not supported for this Source.

---

Schema and Primary Keys

Hevo uses the following schema to upload the records in the Destination. For a detailed view of the objects, fields, and relationships, click the ERD.

---

Data Model

The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:

---