Getting started with the Automated Test Framework

  • Release version: Australia
  • Updated March 12, 2026
  • 3 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 Getting Started with the Automated Test Framework

    The Automated Test Framework (ATF) is designed to facilitate testing within ServiceNow instances. New users are encouraged to start with a basic tutorial to create and run simple tests, progressing to more advanced features as they gain confidence.

    Show full answer Show less

    Key Features

    • Service Catalog in Service Portal: Conduct end-to-end testing of catalog items, including setting variables, validating prices, and navigating order guides.
    • Application Navigator: Verify the presence of application menus and modules, and simulate user navigation.
    • Custom UI Testing: Create tests that mimic user actions without scripting, including validating components and their states.
    • Form Testing: Test various form functionalities such as field value validation, visibility checks, and UI action interactions.
    • REST Testing: Evaluate REST endpoints by sending requests, verifying responses, and manipulating records.
    • Server Testing: Execute unit tests using JavaScript, focusing on business rules and script includes.
    • Output Variables: Utilize output variables from one test step as inputs for subsequent steps, enhancing test interactions.
    • Custom Test Step Configurations: Create tailored test steps that accept and return user-defined variables, limited to server-side execution.
    • Data Preservation: The framework automatically manages data created during tests, ensuring a clean rollback post-testing.
    • Test Suites: Organize tests into suites that can run in a specified order, allowing for hierarchical structuring and scheduling.

    Key Outcomes

    By leveraging the Automated Test Framework, ServiceNow customers can streamline their testing processes, ensuring that applications and services function correctly while maintaining data integrity. Customers can expect enhanced testing capabilities, increased efficiency, and the ability to manage complex test scenarios effectively.

    Next Steps

    Once comfortable with basic testing, users should explore advanced features, including domain separation, to optimize their testing strategies and better manage data visibility and access.

    If you are new to the Automated Test Framework, read this overview to learn what the framework can do. Next, follow the tutorial to create and run a test that uses the most basic of ATF features. After you feel comfortable with the basics, explore more advanced features provided by the ATF.

    ATF features provide flexibility in how you test your instance.

    Test step configuration categories

    Category Description
    Service Catalog in Service Portal Perform end-to-end testing for a catalog item in the Service Portal.
    • Open a record producer, catalog item, or order guide.
    • Set variable values and catalog item quantity.
    • Validate variable values, states, price, and items included in an order guide.
    • Navigate in an order guide.
    • Open and toggle catalog items in an order guide.
    • Add an item or an order guide to a shopping cart.
    • Order a catalog item or an order guide.
    • Submit a record producer.
    Application Navigator Create tests to check navigation features.
    • Verify that application menus are listed in the left navigation bar.
    • Verify that application modules are listed in the left navigation bar.
    • Navigate to a module as if a user clicked the module in the left navigation bar.
    Custom UI Create simple tests that mimic user actions with no scripting.
    • Set component values.
    • Assert that specified text is or is not on a page.
    • Validate component values.
    • Click components.
    • Validate the states of components (read-only or not read-only).
    Form Create tests of forms.
    • Open a new form or an existing record.
    • Set field values.
    • Validate field values or field states (such as mandatory, not mandatory, read only, not read only, visible, and not visible).
    • Validate whether a UI action is visible.
    • Click a button on a modal page.
    • Click a UI action.
    • Submit a form.
    Service Catalog Perform end-to-end testing for a catalog item.
    • Open a catalog item or a record producer.
    • Search for a catalog item.
    • Set variable values and catalog item quantity.
    • Validate variable values, states, and price.
    • Add an item to a shopping cart.
    • Order a catalog item.
    • Submit a record producer.
    Forms in Service Portal Create tests of forms in the Service Portal.
    • Open a form.
    • Set field values.
    • Validate field values or field states (such as mandatory, not mandatory, read only, not read only, visible, and not visible).
    • Validate whether a UI action is visible.
    • Click a UI action.
    • Submit a form.
    REST Create and send an Inbound REST request and verify the response.
    • Test any REST endpoint on the instance.
    • Use a REST request to create records, as well as retrieve, update, or delete records created in a previous test step or that already existed on the instance.
    • Verify the response status code, response headers, response time, and response payload.
    Server Perform more complex operations, including the following:
    • Perform unit tests using JavaScript, including tests using the Jasmine test framework.
    • Test business rules, script includes, and other scripts.
    • Create tests that operate on data that you define.

    Output variables

    Many test steps return output variables whose values you can use as inputs to a later step. For example, you can use output variables to accomplish the following tasks:
    • Perform a server-side assert on a record that you previously inserted.
    • Create a record as one user, and then reopen its form as a different user.

    Custom test step configurations

    In addition to the steps built into the Automated Test Framework, you can create custom test step configurations. These custom steps can take input variables and return output variables that you define.
    Note:
    You can only define custom test steps that run on the server. The Automated Test Framework does not support creating custom step configurations that run on the browser.

    Data preservation

    The Automated Test Framework automatically tracks and deletes any data created by running tests, and automatically rolls back changes after testing.

    Test suites

    Test suites enable you to execute a batch of tests in a specified order. In addition, test suites can be hierarchical, with suites nested within other suites. You can associate test suites with schedules that determine when the system runs the test suites.