Properties
Summarize
Summary of Properties
The Properties form in ServiceNow's Automated Test Framework (ATF) allows you to configure system parameters that control the execution of automated tests and test suites. These settings provide granular control over test enabling, scheduling, debugging, screenshot behavior, custom UI data capture, test runner management, test suite reporting, and email notifications.
Show less
Key Features
- Test Execution and Scheduling: Enable or disable the running and scheduling of tests/test suites on your instance to prevent unintended test runs, especially on production environments.
- Debugging: Activate additional debugging tools such as a debugging tab in the Test Runner UI and saving detailed test result JSON data for troubleshooting.
- Screenshot Management: Control when screenshots are taken during tests (all steps, failed steps only, or none), enable enhanced screenshot fidelity with GlideScreenshot for Workspaces, capture full page screenshots with dynamic resizing, and configure screenshot timeouts and dimensions to balance detail versus performance.
- Custom UI Page Data Capture: Decide whether Custom UI test steps retrieve fresh page data on each run (helpful during UI development) or use cached data for faster execution after development is complete.
- Test Runner Settings: Manage test runner heartbeat intervals and timeouts to monitor runner availability, and define retention periods for offline test runners before automatic deletion.
- Test Suite Reporting: Configure how many test suite results appear in aging reports to keep report data relevant and manageable.
- Email Notifications: Customize the content and appearance of scheduled suite result emails, including filtering to show only failed tests, limiting the number of test results, setting print depth for nested results, and defining color codes for test statuses (failed, errored, passed, skipped, canceled) to enhance readability.
Practical Benefits for ServiceNow Customers
- Prevent accidental test runs on production by disabling test execution by default.
- Improve test troubleshooting with enhanced debugging options and detailed result data.
- Optimize screenshot capturing to balance test performance and diagnostic detail, including support for modern UI interfaces.
- Accelerate test execution in stable UI environments by disabling frequent page data retrieval.
- Maintain reliable test runner monitoring and cleanup, ensuring system resources are managed effectively.
- Generate concise, focused test suite reports and emails tailored to your team’s needs for quicker insights.
- Enhance email alerts with clear visual cues to rapidly identify test outcomes and issues.
On the Properties form, you can set parameters that control how the system executes automated tests and test suites.
| 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. |
| 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. |
| 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 |
|
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 |
| 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. |
| 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. |
| 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. |
| 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. |