Search

TestRail Integration

The TestRail integration makes automated test results from Functionize visible in TestRail for reporting and traceability. This native integration works with TestRail Cloud and lets you link Functionize automated tests with TestRail test cases. Once linked, orchestration results flow back into TestRail, allowing you to manage both manual and automated results from a single reporting hub.

With this integration, you gain:

  • Centralized reporting across manual and automated testing.
  • Seamless traceability with hyperlinks between both tools.
  • Aligned statuses between Functionize executions and TestRail test cases.

Key Notes Before Setup

  • Only TestRail Cloud is supported.
  • The integration supports the Single Repository for all cases project type.
  • Administrative permissions are required in both Functionize and TestRail.
  • Once the integration is configured, regular users can link tests, but only admins can edit mappings and status configurations

Step 1: Configure TestRail

Enable API Access

  1. Log in to TestRail as an Administrator.
  2. From the top-right, click Administration.
  3. In the right panel, select Site Settings → API tab.
  4. Enable API settings.

Add a Custom Result Field

Functionize results are displayed in TestRail via a custom field.

  1. Go to Administration → Customizations → Result Fields.
  2. Click + Add Field.
  3. Enter the following details:
    • Label: Functionize Result Link
    • System Name: functionize_test_result_link
    • Type: URL (Link)
    • Description: (Optional)
    • Templates/Projects: Assign to the templates/projects you want linked.
      • Templates: Select either “This field applies to all templates” or “This field applies to the following templates only.” Then, choose the appropriate template from the dropdown.
      • Projects: Click on “Add Projects & Options” and select the required projects from the field provided.
  4. Save the field.

Step 2: Configure Functionize

Access Integration Settings

  1. In Functionize, log in as a Team Administrator.
  2. Navigate to the Team tab → Integrations.
  3. Under Test Case Management, select TestRail.

Establish the Connection

  1. In the Test Authentication/Connection section, provide:
    • TestRail URL
    • Username
    • Password
    • Timeout (secs)
    • Test Plan Check (optional)
    • Proxy (optional)
  2. Click Test Sign In to confirm the connection.
    • Note: Use a TestRail Admin account so Functionize can generate custom fields.

Map Projects and Statuses

  1. Under Project Mappings, select:
    • Functionize Project & Environment.
    • TestRail Project from the dropdown.
  2. Map Functionize statuses to TestRail statuses:
    • FAILED → Failed
    • INCOMPLETE → Blocked
    • WARNING → (Custom, if enabled)
    • PASSED → Passed
  3. Click Save Mappings.

(Optional) Customize TestRail Statuses

You can adjust TestRail status labels to align with Functionize:

  1. In TestRail, go to Administration → Customizations → Statuses.
  2. Edit or rename statuses (e.g., rename “Unnamed” to “Warning”).
  3. Ensure statuses are active, then save.
  4. Updated statuses will be available in Functionize mapping dropdowns.

Step 3: Using the Integration

Integration Workflow

  1. Automate TestRail Test Cases – Use Architect to automate manual tests.
  2. Link Test Cases – Connect Functionize automated tests to TestRail test cases.
  3. Run Orchestration – Execute orchestrations in Functionize.
  4. Report in TestRail – Orchestration results appear automatically in TestRail as a new test run.

Note: Results are synced in near real-time, however large orchestrations may take a few minutes to fully appear in TestRail.

Linking Test Cases

  1. Open the linked project in Functionize.
  2. In the test list, click the TestRail logo + Link Test.
  3. In the pop-up, search and select the TestRail test case.
  4. Click Link Test → confirmation message appears.

Running Orchestrations

  • Orchestrations group multiple tests to run in parallel or sequence.
  • To configure orchestrations to send data to TestRail:
    • Go to Edit Orchestration and view the Advanced tab.
    • Set the Submit Linked Tests to TCM dropdown to an automatic option:
      • Automatically after any passing orchestration
      • Automatically after any orchestration execution 
  • When executed, orchestration results are automatically sent to TestRail.
  • This includes dashboards and management-level QA reports.

Viewing Results in TestRail

  1. In TestRail, go to Test Runs & Results.
  2. Each Functionize orchestration creates a new Test Run, named:
    <Functionize Orchestration Name>: <Date & Timestamp>
  3. Inside the Test Run:
    • See execution results from Functionize.
    • Click Functionize Orchestration Link for orchestration-level details.
    • Click Functionize Result Link for test-level details.

Note: You do not need a Functionize account to view results—links open read-only, making it easy to share with developers or non-Functionize users.

Enabling the Result Link Column

  1. In TestRail, open a test run.
  2. Click Columns.
  3. Select Functionize Result Link All.
  4. Save → the column now appears in your test run view.

Benefits of the Integration

  • Visibility: Consolidates Functionize automation and TestRail manual results.
  • Traceability: Maintains direct links across tools.
  • Collaboration: Makes Functionize results accessible to non-users.
  • Flexibility: Supports custom statuses to match organizational workflows.

Best Practice: Start by linking Functionize tests only for your most critical TestRail cases. Once workflows are stable, expand coverage to larger test suites for maximum reporting value.