TestRail Integration

Integrate Functionize test automation with TestRail to allow automated test results from Functionize to be visible in TestRail for reporting purposes. This native integration allows you to connect to TestRail Cloud, TestRail Enterprise Cloud, or Enterprise Server. After the integration is setup, you can link a test from Functionize to the corresponding test case TestRail. Then, when the test is executed through an orchestration in Functionize, the orchestration results will populate into a TestRail test run. From both tools, you can see fields that are mapped, including the Status and ID. You also have a hyperlink to navigate easily between linked objects across the two tools.

Setting up the Integration

To set up the native integration, you can configure the project mapping in the Functionize project's Integration Settings. You will also need administrative permissions in TestRail to configure the integration from TestRail as well.

Note: We only support TestRail Cloud and the project type: "Single Repository for all cases" (see image below)




Configure TestRail

1. Click on Administration from the top right corner. Select Site Settings from the right navigation panel. Then, select the API tab.


2. Navigate from Administration >> Customizations >> Result Fields. Click on the + Add Field in order to enter the new custom field. This field for Functionize Result Link will be used to insert a direct link from the TestRail test run back to the Functionize Test Result on every execution.  mceclip2.png

3. In the Add Custom Field page, fill out the field details as described and shown in the image below:

  • Enter the Label of "Functionize Result Link"
  • Enter the System Name as functionize_test_result_link
  • Select Type as Url (Link)
  • The description field is optional
  • Select the templates and projects appropriate for any project you'd like to link to Functionize

Configure Functionize 

Navigate to Integration Settings

1. As a Functionize Team Administrator, navigate to the Team tab.


2. Click on the Integrations tab. Then, select the TestRail radio button from the left menu underneath Test Case Management.


Establish the Connection

3. Under Test Authentication/Connection, enter the credentials for your TestRail Cloud instance:

  • URL
  • Username
  • Password
  • Proxy URL and Port fields are only required for a proxy connection. If you are not using a proxy, skip these fields.

Note: These credentials must be for a TestRail administrator since the integration will generate custom fields into TestRail once the connection is established.

4. Click the Test Sign In button to establish the connection. See below example: 


Map Projects and Statuses

5. Set up the Functionize project(s) under Projects Mappings. By default, the project mapping feature will be activated, as indicated by the toggle switch shown below.

mceclip3.png6. Select the Functionize Project to link, along with the Site Environment.

7. Select the TestRail Project from the dropdown menu. 


8. Map the values for Functionize Status to the TestRail Status values. Functionize's default status values are: FAILED, INCOMPLETE, WARNING, and PASSED. For the integration to work properly, these statuses should be mapped to status values in TestRail.

   ** Optionally, you can customize the statuses for the TestRail status values within TestRail. See how in the section below**

9. Click Submit.

10. A confirmation message will display indicating the mapping was successful.

Optional: To Customize the Available TestRail Statuses

   1. Log into TestRail as an administrator.

   2. Click on the Administration tab on the far right.

   3. Click on Customizations from the right navigation panel.

   4. Click on the Statuses tab.


   5. Customize the Status names as desired.  In this example we are naming the Unnamed 2 status to       Warning.


   6. Confirm "This status is active" and then click Save Status.

   7. Now the new TestRail status will be available in the dropdown menu for TestRail statuses in the Project Mappings configuration. See below:



Using the Integration

Functionize + TestRail Integration Flow

Once you complete setting up the integration, you can now use the integration. This integration is designed to use the best of both tools. When manual tests from TestRail are ready to be automated, you can easily automate that test using Architect. To learn how to create automated tests using Architect, check out this guide: Getting Started with Architect.

Once the automated test is created using Architect, you link the Functionize test to the corresponding TestRail test case.  Next, run the test using an orchestration. The orchestration result is populated in TestRail for viewing. Through this flow, you will be able to navigate easily from both tools using hyperlinks and be able to view the integrated data. See the flow below:

TestRail flow diagram

Linking Test Cases

1. Navigate to the linked project in Functionize, and then click on View Project.

2. Notice that all tests in this linked project now display the TestRail logo. You can also see the ability to link each individual test to a TestRail test case, as indicated by the +Link Test hyperlink. 


3. Find the Functionize test you wish you link to TestRail. Then, click on the +Link Test hyperlink.

4. In the TestRail Linking window, find your TestRail test case. You can either type in the TestRail test case name or choose from the folder list of test cases. Select the test case using the radio button and click Link Test

5. A "Test Case mapped successfully" confirmation will display and now the Functionize test case has been linked to the TestRail test case, as shown below:


Running an Orchestration

Create an orchestration in Functionize. An orchestration is a grouping of tests, designed to run multiple tests in bulk. To learn how, check out this guide: Create an Orchestration.

Viewing Results in TestRail

Each time the orchestration is executed from Functionize, it will create a new Test Run in TestRail. The Test Run will show all the test cases that were executed as part of that orchestration.

1. In TestRail, navigate into your linked project. Then, click on Test Runs & Results from the top navigation bar.

2. Click into the test run name from the Test Runs & Results page. By default, the test run will be created by the integration using this syntax:
<Name of Functionize Orchestration>: <Date and Timestamp of Execution>.


3. On the test run page, you can see the execution results from Functionize.

Note: You do NOT need to be a Functionize user in order to view the details. If you click into the Functionize link, you will see the Functionize orchestration or test in read-only mode. This is particularly useful if you want to share the details with your developers or other non-Functionize users.

To view the details of the execution, you can click into the Functionize links (see image below):

  • Functionize Orchestration Link: Click on this link to view the orchestration result in Functionize
  • Functionize Result Link: Click on this link to view the specific test result in Functionize


Enable Functionize Result Link Column

Note: To view the Functionize Result Link column for your TestRail tests, you can enable it by clicking into the Columns button:

In the Add Column window, select the Functionize Result Link option and click the Update Columns button to save.