Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Automated Test Framework Step Config record

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

Field / ElementDescription
NameThe name for this test step configuration.
ActiveTrue if this step configuration is active. Otherwise, false.
Step EnvironmentThe step environment in which a step with this configuration can run.
CategoryThe category assigned to a step with this configuration.
ApplicationThe application scope in which the system runs steps with this configuration.
Batch order constraintConstrains 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 typeFor custom step configurations, this field is always Script.
OrderAn 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 reminderThe 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 descriptionThe 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 scriptGenerates the text that describes a step when a test includes it. For more information, see the example using the description generation script.
Step execution scriptScript \(javascript\) that runs when a step with this config runs.
Input Variables related listThe variables that act as inputs for a step with this config.
Output variables related listThe variables that act as outputs for a step with this config.

Parent Topic:Step configurations