After you’ve connected your solution to TestRail (via import/export), you can run your test suite and report results to TestRail.
When reporting is enabled, Ranorex Studio exports results immediately and automatically as the run progresses (near real-time), including the same results you see in the Ranorex report.
Note: Tests always execute according to the currently selected run configuration. Whether a test case is linked to TestRail affects reporting, not execution.
Enable automatic synchronization
When Enable automatic synchronization is turned on, Ranorex exports test results to TestRail automatically after execution (no manual sync step required).
- You can enable it in either location:
- Tools > TestRail integration > Enable automatic synchronization
- In the wizard after importing, under Import complete, select Enable automatic synchronization.
Run from Ranorex Studio
- Click the TestRail Run button. The Launch test run screen opens.
- Select the project that’s connected to TestRail.
- Choose where to report results:
- Report to a new TestRail run, or
- Report to an existing TestRail run
- Enter/select the run name.
- Click Run and report results to TestRail.
Run naming standard
Runs created by Ranorex follow this format:
[Test Suite Name] - [Timestamp] - [Environment/Configuration]
This makes it easier to differentiate runs that originate from suite-based execution vs case-based targeting, and reduces confusion from duplicate-looking run titles.
Run from a CI tool (command line)
- Click the TestRail Run button. The Launch test run screen opens.
- Select the project connected to TestRail.
- Choose new or existing run.
- Click the Copy button to copy the generated string.
- Paste it into your CI tool step.
Important: Use the built-in Copy button. Manual copy/paste may omit or corrupt the password/token.
Optional CLI flags
Upload screenshots for tests: truploadscreenshots uploads screenshots for tests to the relevant TestRail test result.
- Screenshots are uploaded only for failed tests.
- If no screenshots exist, execution completes without error.
- The CLI /? or /help output includes a description of truploadscreenshots.
Upload the Ranorex report to the run: truploadreport uploads the Ranorex report (PDF/HTML) to the test runs.
-
A PDF is uploaded only if PDF report creation is enabled in Ranorex Studio.
Note: If the option Create individual PDF reports for each test case is enabled, no report is attached to the test run.
- If PDF report creation is disabled, no PDF is sent (even if truploadreport is used).
- If no report file is found, execution completes without error.
- Upload target depends on where results are reported:
- TestRail run, or
- TestRail plan entry (for runs inside plans)
Note:Reports are only attached to standalone test runs and not test runs inside test plans.
Reporting behavior
Once Ranorex Studio has started running the test, results will be reported to the TestRail test run in real time. The Ranorex report will always show the full results for the selected run configuration.
Reporting to a new TestRail run
Ranorex Studio reports results only for test cases that:
- Are linked to TestRail, and
- Are part of the current run configuration
Other test cases still run normally in Ranorex, but are not exported to TestRail.
Reporting to an existing TestRail run
Ranorex Studio reports results only for test cases that:
- Have a matching case in the selected TestRail run, and
- Are part of the current run configuration
If a case has no counterpart in TestRail, Ranorex logs a message in the Ranorex report indicating which cases were not matched.
Iterations
If a test case has iterations, TestRail shows the overall pass/fail like the Ranorex report:
- All iterations pass → case is passed
- Any iteration fails → case is failed
Iteration details appear in the TestRail result comment/details.
Blocked test cases
In Ranorex, blocked means “not executed.”
In TestRail, the closest equivalent is untested, so blocked cases are reported as untested.
Uploading evidence to TestRail
You can upload evidence alongside results to make failures easier to review in TestRail.
Upload screenshots for failed tests
When enabled, Ranorex uploads screenshots to the individual test result in TestRail (using TestRail’s result-attachment endpoint).
Upload Ranorex reports to the run
When enabled and when a report file is available, Ranorex attaches the report to test runs.
Troubleshooting sync/reporting issues
If reporting fails due to API communication, incorrect run IDs, or improper case mappings:
- Ranorex shows a clear error message during execution, and
- detailed logs are available for diagnosing the issue.