Skip to content
Release: Australia · Updated: 2026-04-22 · Official documentation · View source

Test Agent guidelines

Leverage the full potential of Test Agent by following these guidelines.

Supported metadata

Test Agent supports the following metadata:

  • sys_ui_action
  • sys_ui_policy
  • sys_ui_policy_action
  • sys_ui_policy_rl_action
  • sys_script_client
  • sys_ui_script
  • sys_data_policy2
  • sys_ui_action_role
  • sys_ui_action_view
  • sys_ui_base_theme
  • sys_ui_form
  • sys_ui_formatter
  • sys_ui_macro
  • sys_ui_message
  • sys_ui_related_list
  • sys_ui_section
  • sys_ui_view
  • sys_ui_title
  • sys_ui_style
  • sys_ui_theme
  • sys_ui_page
  • sys_ui_context_menu
  • sys_ui_list
  • sys_ui_list_control
  • sys_ui_list_control_embedded
  • sys_ui_list_script_client
  • sys_ui_list_script_server
  • sys_ui_related_list
  • sys_user_role
  • sys_app_application
  • sp_widget
  • sp_instance
  • sys_security_acl_role
  • sys_script
  • sys_app_module
  • sysevent_email_action
  • sys_report
  • sys_security_acl
  • catalog_ui_policy
  • catalog_ui_policy_action
  • sp_theme
  • sp_widget
  • sys_sg_universal_link_path_segment
  • sys_sg_sections_screen_m2m_section
  • sys_sg_location_tracking_details
  • sys_highlighted_value_condition
  • sys_sg_card_size
  • sys_sg_custom_map_config
  • sys_sg_empty_state
  • sys_aw_form_header_secondary_values
  • sys_aw_registered_scripting_modal
  • sys_template
  • sys_sg_alert
  • sys_aw_form_header
  • sys_script_include
  • sys_scriplet_function
  • sys_ui_extension_instance
  • sys_playbook_experience_action_assignment_map
  • sys_df_data_filtration
  • sys_email_address_filt_domain
  • sys_atf_step
  • sys_atf_test
  • sys_atf_step_config
  • atf_input_variable

Exceptions

Test Agent doesn't support the following metadata:

  • Flows
  • Configurable workspace steps
  • Custom UI test steps
  • Custom test steps

Scope and availability

Test Agent is available in the following environments and scopes:

DimensionSupported values
Authoring environmentServiceNow IDE or ServiceNow Studio
Application scopeGlobal, custom, store
Test typesATF unit tests, ATF functional tests
Execution targetCloud runner lanes

Example prompts

  • Write an ATF test in the global scope to validate that an employee can order a laptop from the Service Catalog.
  • Write an ATF test to validate that internal IT knowledge articles are not visible to self‑service users.
  • Write an ATF test to validate that all mandatory fields on the Incident form are completed before submission.

Note: The examples above are prompts for authoring ATF tests in the global scope. To run a test, prompt to execute the ATF test by specifying its name or sys_id. To troubleshoot a failure, prompt to triage the failed ATF test by providing the test name or the sys_id of the test result.