Automated Test Framework Step Config record

reference brazil Updated Sep 10, 2026 2 min read atf-step-config-record.md
Raw file servicenow.com

The step config record controls how a test step of this type behaves.

Field / Element

Description

Name

The name for this test step configuration.

Active

True if this step configuration is active. Otherwise, false.

Step Environment

The step environment in which a step with this configuration can run.

Category

The category assigned to a step with this configuration.

Application

The application scope in which the system runs steps with this configuration.

Batch order constraint

Constrains where a step with this configuration can appear in a test:- None: A step based on this configuration can appear at any point in a test.

  • Start Batch Execution: If a test includes this a step based on this configuration, it must be the first step in the test.
  • Run in the middle of an execution: If a test includes a step based on this configuration, it cannot be the first or last step.
  • Stop Execution: If a test includes a step based on this configuration, it must be the last step in the test.

Class type

For custom step configurations, this field is always Script.

Order

An integer specifying where steps with this configuration appear in the step list on the Add Test Step dialog. For more information, see the example using the Order field.

Template reminder

The instructions that appear when a step with this configuration is included in a test as part of a template. For more information, see theexample of using the Template reminder field.

HTML description

The text that appears when the cursor highlights a step with this configuration on the Create New Step dialog. For more information, see the example using the HTML description field.

Description generation script

Generates the text that describes a step when a test includes it. For more information, see the example using the description generation script.

Step execution script

Script (javascript) that runs when a step with this config runs.

Input Variables related list

The variables that act as inputs for a step with this config.

Output variables related list

The variables that act as outputs for a step with this config.

**Parent Topic:**[Step configurations](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/application-development/automated-test-framework-atf/step-configurations-module.md)
Search documentation
Search document titles and file paths on the brazil branch