Properties

Yokohama Build or modify applications

Release

yokohama

ft:locale

en-US

ft:publication_title

Yokohama Build or modify applications

ft:clusterId

cadev

bundleId

cadev

workflow

Development, Data, and Analytics

Properties

Release version: Yokohama

Updated January 30, 2025

4 minutes to read

Summarize

Summarized using AI

Summary of Properties

This document outlines the key system properties available on the Properties form in ServiceNow’s Automated Test Framework (ATF). These properties allow you to configure how automated tests and test suites execute, how debugging and screenshots are handled, and how test results are reported and emailed. Proper configuration of these properties helps optimize test execution, debugging, and reporting to better fit your instance and testing needs.

Show full answer Show less

Test and Scheduling Execution Properties

Enable test/test suite execution (snatf.runner.enabled): Controls whether tests and suites can be run on the instance. Disabled by default to avoid accidental runs on production.
Enable scheduled test suite execution (snatf.schedule.enabled): Allows scheduling of test suites for automated execution.

Debugging Properties

Enable additional debugging functionality (snatf.debug): Activates features like a debugging tab in the Test Runner UI and saving JSON-formatted UI test results to records for enhanced troubleshooting.

Screenshot Properties

Screenshot capture mode (snatf.screenshots.mode): Choose to capture screenshots for all test steps, only failed steps, or disable screenshots entirely to balance diagnostics with performance.
Use GlideScreenshot (snatf.screenshots.useglidescreenshot): Improves screenshot quality, especially in Workspace interfaces; falls back to html2canvas if unsupported by browser.
Capture full page in screenshots (snatf.screenshots.capturefullpage): Enables full-page screenshots by resizing the test frame dynamically; off by default due to potential impact on test speed.
Screenshot timeout (snatf.atftestrunner.screenshottimeout): Limits how long screenshot attempts can take before skipping to maintain performance.
Screenshot dimensions (snatf.atftestrunner.testframe.minheight & .minwidth): Set minimum pixel height and width for screenshots to ensure consistent image sizing.

Custom UI Page Data Capture

Enable page data capture for Custom UI tests (snatf.pagedatacapture.enabled): Determines if Custom UI test steps load fresh page data on every run (recommended during UI development for accuracy) or only when manually retrieved (recommended post-development to speed tests).

Test Runner Properties

Test runner timeout (snatf.runner.heartbeat.timeout): Defines how long the system waits without a heartbeat before marking the test runner offline (default 120 seconds).
Heartbeat interval (snatf.runner.heartbeat.interval): Frequency at which the test runner sends heartbeat signals to the server.
Offline test runner retention (snatf.runner.offlineretention.timeout): Duration in days the system retains offline test runner records before deletion.

Test Suite Report Properties

Suite aging report threshold (snatf.schedule.reports.suite.agingthreshold): Controls how many test suite results display in aging reports, helping you monitor test longevity and trends.

Email Reporting Properties

Show only failed results in scheduled emails (snatf.schedule.suiteresultemail.onlyshowfailedresults): When enabled, emails include only failed test results to reduce noise.
Max number of test results in emails (snatf.schedule.suiteresultemail.maxtesthistory): Limits the number of test results shown in scheduled suite result emails.
Max depth for suite results in emails (snatf.schedule.suiteresultemail.maxdepth): Controls the detail level of suite results displayed.
Color coding for test results in emails: Customize colors for test statuses such as failed, errored, passed, skipped, and canceled to improve readability and quick assessment.

On the Properties form, you can set parameters that control how the system executes automated tests and test suites.

Table 1. Test/Test Suite Properties
Field / Element	Description
Enable test/test suite execution sn_atf.runner.enabled	If checked, enables running tests and test suites on this instance. This setting is unchecked by default to prevent users from unintentionally running tests on production instances.
Enable scheduled test suite execution sn_atf.schedule.enabled	If checked, enables scheduling test suites on this instance.

Table 2. Test Debugging Properties
Field / Element	Description
Enable additional debugging functionality sn_atf.debug	Enables additional debugging functionality, including adding a debugging tab on the client Test Runner UI page and saving UI Test Result JSON to the test result record.

Table 3. Screenshot Properties
Field / Element	Description
Enable or disable screenshot capture during test execution. sn_atf.screenshots.mode Note: For additional information, see Set the system property to control when the Automated Test Framework captures screenshots	To capture screenshots for all steps, select Enable for all steps. To capture screenshots only for failed steps, select Enable for all failed steps. To capture no screenshots, select Disable for all steps.
Enable the GlideScreenshot feature sn_atf.screenshots.use_glide_screenshot	Improves the fidelity of screenshots on Workspaces and other interfaces. Note: IE and Safari don't support this property. If this property is disabled or your current browser doesn't support it, html2canvas is used to take screenshots. If you are upgrading to a new release version, this property is set to false by default.
Enable capturing the full page when taking a screenshot sn_atf.screenshots.capture_full_page	Enables dynamic resizing of the test frame and capturing the full page while taking a screenshot. Note: By default, the property is set to false because it can significantly slow test execution time If the property is disabled, only the portion of the page that is visible in the test frame is captured.
Screenshot timeout sn_atf.atf_test_runner.screenshot_timeout	Skips a screenshot capture attempt in the Client Test Runner if it exceeds this value in seconds. Users should review performance settings and browser caches on affected client systems before increasing this value.
Number of pixels for screenshot height sn_atf.atf_test_runner.testframe.min_height	Numeric value representing the number of pixels for the screenshot height. Default value: 600
Number of pixels for screenshot width sn_atf.atf_test_runner.testframe.min_width	Numeric value representing the number of pixels for the screenshot width. Default value: 800

Table 4. Custom UI Page Data Capture Properties
Field / Element	Description
Enable tests with Custom UI steps to capture page data each time they are run. sn_atf.page_data_capture.enabled	When true, Custom UI test steps retrieve page data every time the test runs. Set this property to true when developing custom UI pages to always run tests on the most recent page version. When false, Custom UI test steps do not retrieve page data unless the test designer manually selects Retrieve Components during test design. Set this property to false when UI development is complete to enable faster test runs.

Table 5. Test Runner Properties
Field / Element	Description
Test runner timeout sn_atf.runner.heartbeat.timeout	If there is no heartbeat from the test runner within this period of time in seconds, the status changes from online to offline. The value of this property should be between 120 and 1800. Default value: 120
Test runner heartbeat interval sn_atf.runner.heartbeat.interval	Time interval in seconds for sending a heartbeat from the test runner to the server.
Offline test runner retention interval sn_atf.runner.offline_retention.timeout	If an offline test runner does not communicate with the system for this period of days, the system deletes that test runner.

Table 6. Test Suite Report Properties
Field / Element	Description
Test suite report properties sn_atf.schedule.reports.suite.aging_threshold	The number of test suite results to display in the test suite aging report.

Table 7. Email Properties
Field / Element	Description
Boolean value for results displayed in scheduled suite result emails. sn_atf.schedule.suite_result_email.only_show_failed_results	When true, the scheduled suite test result emails only show results that failed. When false, displays all results.
Maximum number of test results to be displayed in scheduled suite result emails. sn_atf.schedule.suite_result_email.max_test_history	Maximum number of test results to be displayed in scheduled suite result emails.
Maximum depth when printing suite results in suite result emails. sn_atf.schedule.suite_result_email.max_depth	Maximum depth when printing suite results in suite result emails.
Color to indicate an ATF test failed in scheduled suite result emails. sn_atf.schedule.suite_result_email.fail_color	Hexadecimal code for color to indicate an ATF test failed in scheduled suite result emails.
Color to indicate an ATF test errored in scheduled suite result emails. sn_atf.schedule.suite_result_email.error_color	Hexadecimal code for color to indicate an ATF test errored in scheduled suite result emails.
Color to indicate an ATF test passed in scheduled suite result emails. sn_atf.schedule.suite_result_email.pass_color	Hexadecimal code for color to indicate an ATF test passed in scheduled suite result emails.
Color to indicate an ATF test was skipped in scheduled suite result emails. sn_atf.schedule.suite_result_email.skip_color	Hexadecimal code for color to indicate an ATF test was skipped in scheduled suite result emails.
Color to indicate an ATF test was canceled in scheduled suite result emails. sn_atf.schedule.suite_result_email.cancel_color	Hexadecimal code for color to indicate an ATF test was canceled in scheduled suite result emails.