Step results record

  • Release version: Yokohama
  • Updated January 30, 2025
  • 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 captures detailed information about an individual step within a test result in ServiceNow. Customers can view specific step results through the Step Results related list found in the Test Results record. This record helps track the outcome, timing, and detailed output of each test step, enabling precise analysis and troubleshooting of test executions.

    Show full answer Show less

    Key Fields and Their Uses

    • Status: Indicates the outcome of the test step with values such as Success, Failure, Success with warnings, Skipped, Error, or Cancelled. For example, "Success with warning(s)" means the step passed but encountered client errors that are allowed as warnings.
    • Type: Specifies if the record is a Step Result or a Summary.
    • Summary: Provides a concise version of the output, including error messages when client errors occur. It assists test designers and developers in quickly identifying and investigating client errors.
    • Output: Contains detailed generated output for the step, including failure reasons or skipped status. For REST request steps, it includes the request and response data (with sensitive headers redacted).
    • Step: The name of the executed test step.
    • Test Result: Reference link to the parent test result record for additional context.
    • Description: Describes the specific actions performed in the step, such as opening a form or validating conditions.
    • Start Time and End Time: Timestamps marking the beginning and end of the step.
    • Duration: The total time taken to execute the test step.
    • Step Transactions (related list): Contains records of each transaction related to this step, useful for deeper system-level analysis.

    Practical Benefits for ServiceNow Customers

    • Enables granular visibility into each test step’s performance and outcome, facilitating efficient root cause analysis.
    • Supports investigation of client errors by providing detailed error messages and guidance on managing allowed warnings.
    • Helps maintain security by filtering sensitive REST request and response headers from logs.
    • Integrates with related records like Test Logs and Test Results, offering a comprehensive view of test executions.
    • Allows configuration to ignore certain client errors in future runs, improving test reliability and reducing noise.

    Related Concepts and References

    • Allowed client errors: Defines which client errors can be treated as warnings rather than failures.
    • Test results and Test logs records: Additional sources to review for complete test execution details and diagnostics.

    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).