Automated Test Framework Step Config record
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.
|
|
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. |
--- title: Automated Test Framework Step Config record description: The step config record controls how a test step of this type behaves. locale: en-US canonical_url: https://www.servicenow.com/docs/r/application-development/automated-test-framework-atf/atf-step-config-record.html release: brazil product: Automated Test Framework \(ATF\) classification: automated-test-framework-atf topic_type: reference last_updated: "2026-09-10" reading_time_minutes: 2 breadcrumb: [Step configurations, Administration, Automated Test Framework \(ATF\) reference, Automated Test Framework \(ATF\), Testing and debugging applications, Classic app development, Building applications] --- # Automated Test Framework Step Config record The step config record controls how a test step of this type behaves. <table><thead><tr><th> Field / Element </th><th> Description </th></tr></thead><tbody><tr><td> Name </td><td> The name for this test step configuration. </td></tr><tr><td> Active </td><td> **True** if this step configuration is active. Otherwise, **false**. </td></tr><tr><td> Step Environment </td><td> The [step environment](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/application-development/automated-test-framework-atf/step-environments-module.md) in which a step with this configuration can run. </td></tr><tr><td> Category </td><td> The [category](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/application-development/automated-test-framework-atf/step-configuration-categories-module.md) assigned to a step with this configuration. </td></tr><tr><td> Application </td><td> The application scope in which the system runs steps with this configuration. </td></tr><tr><td> Batch order constraint </td><td> 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. </td></tr><tr><td> Class type </td><td> For custom step configurations, this field is always **Script**. </td></tr><tr><td> Order </td><td> 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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/application-development/automated-test-framework-atf/atf-step-config-xmpls.md). </td></tr><tr><td> Template reminder </td><td> The instructions that appear when a step with this configuration is included in a test as part of a template. For more information, see the[example of using the Template reminder field.](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/application-development/automated-test-framework-atf/atf-step-config-xmpls.md) </td></tr><tr><td> HTML description </td><td> 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.](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/application-development/automated-test-framework-atf/atf-step-config-xmpls.md) </td></tr><tr><td> Description generation script </td><td> Generates the text that describes a step when a test includes it. For more information, see the [example using the description generation script](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/application-development/automated-test-framework-atf/atf-step-config-xmpls.md). </td></tr><tr><td> Step execution script </td><td> Script \(javascript\) that runs when a step with this config runs. </td></tr><tr><td> Input Variables related list </td><td> The variables that act as inputs for a step with this config. </td></tr><tr><td> Output variables related list </td><td> The variables that act as outputs for a step with this config. </td></tr></tbody> </table>**Parent Topic:**[Step configurations](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/application-development/automated-test-framework-atf/step-configurations-module.md)
| title | Automated Test Framework Step Config record |
| description | The step config record controls how a test step of this type behaves. |
| locale | en-US |
| canonical_url | https://www.servicenow.com/docs/r/application-development/automated-test-framework-atf/atf-step-config-record.html |
| release | brazil |
| product | Automated Test Framework \(ATF\) |
| classification | automated-test-framework-atf |
| topic_type | reference |
| last_updated | 2026-09-10 |
| reading_time_minutes | 2 |
| breadcrumb | Step configurationsAdministrationAutomated Test Framework \(ATF\) referenceAutomated Test Framework \(ATF\)Testing and debugging applicationsClassic app developmentBuilding applications |