Search

Xray Integration

Functionize integrates with Xray (for Jira Cloud, Server, and Data Center) to provide complete visibility into automated test results and metrics. By combining Functionize automation with Xray test management, teams can centralize reporting, enhance automation coverage, and streamline navigation between the two platforms.

Why Integrate Functionize with Xray?

  • Automation Coverage: Share automated test results with a wide audience.
  • Centralized Reporting: View manual and automated results in a single place.
  • Enhanced Automation: Use Functionize’s Architect to quickly automate manual Xray tests without writing code.
  • Seamless Navigation: Use hyperlinks between Functionize and Xray for easy cross-tool traceability.
  • Traceability – Link Functionize test executions directly to Jira requirements and defects for full traceability.

Integration Workflow

  1. Create a Manual Test in Xray – Define the test case in Jira/Xray.
  2. Automate with Functionize – Use Architect to build the automated version.
  3. Link the Tests – Map the Functionize automated test to the Xray manual test.
  4. Create an Orchestration in Functionize – Group and run linked tests.
  5. Submit Results to Xray – Send orchestration outcomes to Xray (manually or automatically).
  6. View Results in Xray – Access consolidated reporting and dashboards in Jira.

Initial Xray Setup in Functionize

1. Open the Team Page

  • Go to Team → Integrations.

2. Select Xray

  • In the Test Case Management section, choose Xray.
  • Select your deployment type: Cloud or Server/Data Center.

3. Provide Connection Details

Enter:

  • Jira Project URL
  • Jira Username
  • Jira API Token (not password)
  • For deployment type:
    • Server/Data Center:
      • Proxy URL
      • Port
    • Cloud:
      • Xray Client ID
      • Xray Client Secret
  • Timeout (secs)

Note: Client details can be found by a Jira Admin under Apps → Manage Apps → API Keys.

Click Test Sign In → status should update to Connection established.

4. Map Projects and Statuses

  • In Project Mappings, select the Functionize and Xray projects to link.
  • Choose the corresponding Functionize Project Environment.
  • Map Functionize statuses (PASSED, FAILED, WARNING, INCOMPLETE) to Xray statuses.
  • Click Save Mapping.

Linking Test Cases

  1. Open the linked Functionize Project.
  2. Confirm the project environment is mapped to Xray.
  3. In the test list, click + Link Test.
  4. In the pop-up window:
    • Select one or more Xray test cases (from different folders if needed).
    • Click Link Test.
  5. Once linked, the Xray test name will appear in place of + Link Test, with pencil and X icons to edit or remove the link.

Sending Results to Xray

1. Create an Orchestration

  • Go to Orchestrations → + Create New Orchestration.
  • On the Details tab: fill in orchestration info.
  • On the Advanced tab: Choose submission type (automatic or on demand).
  • On the Integrations tab: Link to an Xray Test Plan by selecting from the dropdown (optional).
  • Add tests, then click Confirm.

2. Execute the Orchestration

  • Start the orchestration from the Execute column.
  • Confirm in the modal.
  • After the run, click Results to review outcomes.

3. Submit Results to Xray

  • If configured as automatic, results are sent to Xray immediately.
  • If set to on demand:
    • Open the orchestration results.
    • Click Submit to Xray.
    • A modal displays the linked Xray Test Execution with a hyperlink.

Note: Linking to a Test Plan updates the connection for future runs, not past executions.

Viewing Results in Xray

  • Each Functionize orchestration run creates a Test Execution issue in Xray.
  • All test results (including cross-browser and multiple dataset runs) are consolidated into that execution.
  • If any configuration fails, the corresponding Xray test case is marked as Failed.
  • Two-way linking lets you jump directly between Functionize and Xray via hyperlinks.

Tests run in Functionize but not linked to Xray cases will appear in the orchestration results table, but will not be included in the Overall Execution Status in Xray.

Benefits of the Integration

  • Unified Reporting – See Functionize results in Jira dashboards and management reports.
  • Traceability – Maintain strong links between business-level test cases and execution results.
  • Scalability – Automate Xray manual cases at scale with Functionize Architect.
  • Flexibility – Choose automatic or on-demand result submissions based on your workflow.

Best Practice: Start by linking Functionize tests for high-value Xray test cases (e.g., regression or release-blocking tests). This ensures stakeholders gain immediate visibility where it matters most.