Allowed client errors
Summarize
Summary of Allowed Client Errors
The Allowed Client Errors feature in ServiceNow's Automated Test Framework (ATF) enables test designers and developers to manage known client-side JavaScript errors during automated testing. By adding specific errors to the allowed list, tests can proceed without being impacted by these known issues, facilitating smoother test execution and design.
Show less
Key Features
- Allowed Client Errors List: This list allows tests to continue running despite known client errors, such as those arising from old forms or libraries.
- Report Levels: You can set report levels to determine how the framework handles these errors in future tests—either as warnings or ignored, which can be adjusted at any time.
- Matching Process: The framework identifies allowed errors by checking if the error message contains a specified string from an Allowed Client Error record.
- Manual Entry: Users can manually create entries in the Allowed Client Errors table to manage errors as necessary.
Key Outcomes
By utilizing the Allowed Client Errors feature, ServiceNow customers can:
- Prevent specific known errors from disrupting test results, thereby enhancing test design efficiency.
- Control how errors are reported and managed, allowing for more effective troubleshooting and resolution.
- Ensure that tests are comprehensive by allowing the investigation of client errors without immediate disruption.
Add known client errors to the allowed client errors list to allow tests and steps to continue running when a specific error occurs. Set the report level to specify what the Automated Test Framework does when the error occurs in future tests.
Scenarios for allowing client errors
Test designers and developers typically allow client-side JavaScript errors to prevent certain types of known failures from impacting test design and results. Scenarios to allow client errors include:
- Timing constraints
- Temporarily allow a client error until your developers have time to investigate and resolve the issue. For example, when testing an old form containing a longstanding bug.
- Minimizing the impact of old libraries
- Ignore client errors that cannot be fixed or are unimportant to your operations to eliminate their impact on future test runs. For example, when you find a bug in an old library.
- Test design time
- Temporarily allow client errors until you finish writing tests and have time to investigate the error. For example, one of your developers modifies a UI policy and the change generates an error.
- Possible platform bug
- Temporarily allow client errors until a fix is available. Prior to reporting a platform bug to ServiceNow Technical Support, investigate the error, verify it is not a customization error, and identify the type of platform bug involved. For example, a UI policy generates an error during a test. Your investigation verifies that the issue is not a customization error and identifies a platform issue with the UI policy.
Report levels for allowed client errors
The report level indicates whether the test framework reports future occurrences of the error as a warning or ignores them altogether. You can change the report level of an allowed error at any time. For example, if you originally add an error as a warning, you can later change the report level to ignored.
| Report level | Description |
|---|---|
| Warning | Test steps containing the allowed client error report a status of Success with warning(s). The error message appears in the test result output, and is recorded in the test logs with the status Warning. |
| Ignored | Test steps containing the allowed client error report a status of Success. The error is recorded in the test logs with an Ignored status. |
Matching process
Identifying and resolving client errors
When client errors occur, the Automated Test Framework fails the test on the step that was executing when the error occurred.