Step results record

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Step Results Record

    The Step Results record provides detailed insights into the outcome of individual steps within a test result in the Automated Test Framework (ATF). Users can access this information through the Step Results related list of the Test Results record, which helps in evaluating the success and issues encountered during testing.

    Show full answer Show less

    Key Features

    • Status: Indicates the outcome of the test step, which can be Success, Failure, Success with warnings, Skipped, Error, or Cancelled.
    • Type: Specifies the category of the test result item.
    • Output: Displays generated outputs, including any errors or explanations for failures or skips, with a limit of 4096 characters.
    • Step Name: Identifies the specific step executed during the test.
    • Start/End Time: Captures the timing of the test step execution, helping to assess duration.
    • Step Transactions: Lists transactions related to the step result, aiding in troubleshooting and analysis.

    Key Outcomes

    By utilizing the Step Results record, ServiceNow customers can effectively monitor and debug their application tests. This enables clear identification of issues, such as client errors or test failures, ensuring that business processes are functioning as intended. Customers are encouraged to investigate client errors and utilize the "Add all client errors to warning/ignored list" feature to streamline future test runs. Comprehensive logging and detailed reports help in optimizing the testing process and maintaining application quality.

    The Step Results record contains information about one step in a test result. You access specific step results from the Step Results related list in the Test Results record.

    Field Description
    Status Result of the step:
    Success
    Test step passed.
    Failure
    Test step failed.
    Success with warning(s)
    Test step passed but encountered client error(s) that were allowed as warnings in the Allowed Client Error table.
    Skipped
    Occurs if an earlier test in the suite failed and Abort on failure is set to true.
    Error
    An error occurred in the test framework. For example, the test runner halted or the server encountered an unintended scenario.
    Cancelled
    User canceled the test or suite.
    Type Type of test result item: Step Result
    Summary Summarized version of the Output field.

    If an error occurred in the test step, the following text indicates that a client error occurred at this step, and includes a detailed exception/error message.

    This step failed because the client error 'DETAILED ERROR MESSAGE' was detected on the page being tested. See failing Test Logs. To ignore these errors in the next test run, use ‘Add all client errors to warning/ignored list’ links.

    Test designers and developers should always investigate client errors to determine if there are issues with your business process. For more details, see Identify and resolve client errors.

    For a Send REST Request - Inbound step, the URL for the request endpoint, and a response code. For example:

    The HTTP request has been sent to the endpoint 'https://demonightlyus.service-now.com/api/now/table/kb_knowledge'
    Output Generated output for the test step.
    • For a step result, the outputs from the step, including any explanation why a step failed or was skipped.
    • For a Send REST Request - Inbound step, the REST request and response including the response body. The output field is truncated at 4096 characters.
      • The REST request and response headers are filtered to prevent sensitive information from being added to the log. A filtered header text is replaced with the text "Header redacted for security."
      • See Filter REST request and response headers for information on how to add a list of REST request and response headers to be filtered.

    For additional console logging and test execution information for a test step, see the Test Logs record.
    Step Name of the step executed.
    Test Result Reference to the test result associated with this step result. Click the information icon ( Reference field icon) to view detailed test results information.
    Description Description of the specific actions performed (for example, Open Create Incident Report Producer, Validate that the form matches the following condition) for this test step. For a client log, blank.
    Start Time Date and time of day at which this step or log entry started.
    End Time Date and time of day at which this step or log entry ended.
    Duration Elapsed time it took to execute this test.
    Step Transactions (related list) Record for each transaction (from the system transaction log [syslog_transaction] related to this step result.