Step results record

  • Release version: Xanadu
  • Updated August 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 in ServiceNow captures detailed information about an individual step within a test result. It is accessible via the Step Results related list on the Test Results record. This record helps customers understand the outcome and specifics of each test step, supporting effective test management and troubleshooting.

    Show full answer Show less

    Key Features

    • Status: Indicates the outcome of the test step, such as Success, Failure, Success with warnings, Skipped, Error, or Cancelled. This helps quickly identify the step’s result and any issues encountered.
    • Type: Specifies the kind of test result item, for example, Step Result.
    • Summary: Provides a concise overview of the step’s output including any client errors with detailed messages and guidance on how to handle them. For REST request steps, it includes endpoint URLs and response codes.
    • Output: Contains generated output from the test step, such as detailed REST request and response data (with sensitive headers redacted), explanations for failures or skips, and other relevant information. This field is truncated at 4096 characters.
    • Step Name and Description: Identifies the specific step executed and describes the actions performed, aiding in clarity and traceability.
    • Timing Information: Includes Start Time, End Time, and Duration, allowing customers to track execution times for performance insights.
    • Step Transactions: Related records that log system transactions associated with the step, enabling deeper investigation into system activity during testing.

    Practical Use for ServiceNow Customers

    ServiceNow customers can use the Step Results record to:

    • Gain detailed insight into each test step’s execution and outcome to identify and resolve errors efficiently.
    • Access summarized and detailed information about client errors, with recommended actions to investigate or ignore warnings in future test runs.
    • Review REST endpoint interactions within test steps while ensuring sensitive data is protected via filtered headers.
    • Correlate test step results with overall test results and logs for comprehensive test analysis.
    • Utilize timing data and transaction logs to optimize testing processes and troubleshoot performance or system issues.

    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.