Step Generator Dialog Box

Relevant for: GUI tests and scripted GUI components

This dialog box enables you to add steps that perform operations, using test object methods (for tests only), Utility object methods, or function calls.

To access

This dialog box can be accessed from the following locations:

  • Keyword View

  • Editor

  • Function Library

  • Active Screen

To open the dialog box, do the following:

  1. Ensure that a GUI test or action is in focus in the document pane.

  2. Select the location to insert the step, and do one of the following:

    • Right-click and select Insert Step > Step Generator, or Insert Step > Step Generator.

    • Press F7 (not available for Active Screen).

    • Select Design > Step Generator.
Important information

  • Although the Step Generator shows information regarding the currently selected step or function, selections that you make in the Step Generator add a new step or function to your test; they do not modify the existing step or function.

  • In the Step Generator, if you add an operation that returns an object, and the assignment in the test is missing a Set statement, the run session will fail.
UI Elements Description
Category

The type of step to add. The following options are available:

  • Test Objects. Enables you to select a test object and operation for the step (for tests only). For details, see Test Object Category.

  • Utility Objects. Enables you to select a Utility object and operation for the step. For details, see Utility Object Category.

  • Functions. Enables you to select a function for the step from the available library functions (tests only), VBScript functions, and internal script functions. For details, see Function Category.
Object

The list of available objects. The list varies according to the type of object you select in the Category list box.

Note: Available when the selected Category value is Test Objects or Utility Objects.

Library

The type of functions to display in the Operation list. Possible values:

  • All. Displays all functions relevant in the scope from which you opened the Step Generator.

  • Library Functions. Displays all functions defined in functions libraries associated with the action's test. (Available only when opening the Step Generator from an action.)

  • Built-in functions. Displays all of the functions that are part of the VBScript language.

  • Local script functions. Displays all of the functions defined in the action or function library from which you opened the Step Generator.

Note: Available when the selected Category value is Functions.

Operation

For objects: The list of operations available for the selected object type in alphabetical order.

For functions: The list of functions available from the selected library type in alphabetical order.
Arguments

The list of arguments for the operation, if applicable to the selected operation.
Arguments > Name

The name of the argument for the selected operation.
Arguments > Type

The type of the argument value for the selected operation.
Arguments > Value

The value for the argument for the selected operation. Specify the argument value according to the following rules:

  • Mandatory arguments. If the name of the argument is followed by a red asterisk (*), you must specify a value for the argument. You cannot insert the step or view the step documentation if the values have not been defined for all mandatory arguments.

  • Optional arguments. If the name of the argument is not followed by a red asterisk (*), you can specify a value for the argument or leave the cell blank. If you do not specify a value, UFT One uses the default value for the argument. (You can view the default value by moving the pointer over the cell).

  • Required arguments. If you specify a value for an optional argument, then you must also specify the values for any optional arguments that are listed before this argument. If you do not specify these values, UFT One uses the default values for all required arguments. You can see the default value for each argument in a tooltip, by moving the pointer over the Value column.

  • Parameterized arguments. You can use a parameter for any argument value by clicking the parameterization button . For details, see Value Configuration Options Dialog Box.

  • Predefined constants. If an argument has a predefined list of values, UFT One provides a drop-down list of possible values. If a list of values is provided, you cannot manually type a value in this box.
Return Value

The location for storing the return values of the operation, if applicable. For details on storing options, see Storage Location Options Dialog Box.
Step documentation (Keyword View)

Summary information on the current step. The following options are available:

  • For the Test Object or Utility Object categories, the Step documentation box describes the operation performed by the step. When the step is inserted into your test, this description is displayed in the Documentation column in the Keyword View.

    Note: If any mandatory and required argument values have not been defined for the operation, the Step documentation box displays a warning message.

  • For Functions category, step documentation is available for user-defined functions, if you provided this information when defining them. For details, see Create and work with a user-defined function.
Generated step (Editor / Function Library)

The defined statement for the step. If all the mandatory and required argument values have not been defined for the operation, the names of the undefined arguments are highlighted in bold text. If you attempt to insert the step, an error message is displayed.

Example:

Insert another step

Enables you to insert the current step and continue adding steps at the same location. The OK button changes to Insert.

Important information

  • You can select the object for the new step in the context of the currently selected step in your test. Alternatively, you can select any object from the object repository or from your application.

  • After you select the operation for your test object, you can define the relevant argument values.

  • If you click the Operation Help button when a native operation is selected, the UFT One Object Model Reference for GUI Testing help topic opens for the selected test object. For details on specific native operations, see the documentation for the environment or application you are testing.

User interface elements are described below:

UI Elements

Description
Object

All the objects in the object repository that are at the same hierarchical level and location as the currently selected step.

Note: The objects are listed by name in alphabetical order.

Select Object. Enables you to select an object from the object repository or from your application. For details, see Select Test Object Dialog Box.
Test object operations

The UFT One operations that can be performed on a test object.
Native operations

The operations of the object in your application as defined by the object creator.

Note:  

  • If UFT One cannot retrieve native operations for the selected object, the Native operations option is not available.

  • If you select a native operation, the Step Generator inserts a step using .Object syntax. For details on using the Object property, see Native properties and operations.

This option enables you to specify a utility object to insert to your test.

Important information

For details on Utility objects, see the Utility Objects section of the UFT One Object Model Reference for GUI Testing.

User interface elements are described below:

UI Elements

Description
Object

The list of Utility objects that are available.

Note: The image above displays the list of Utility objects that are available when you open the Step Generator from the Keyword View. When you open the Step Generator from the Editor, the list includes a number of additional Utility objects. If you have one or more add-ins loaded, the list may include additional Utility objects for those add-ins.

Important information

For detailed information on a selected built-in VBScript function, see Microsoft's VBScript Reference or the UFT One Object Model Reference for GUI Testing.

User interface elements are described below:

UI Elements

Description
Library

The list of function types. The following options are available:

  • All. Enables you to select a function from all the available functions and types.

  • Library functions. Enables you to select a function from any function library associated with your test (for tests only). For details on defining and using associated function libraries, see Associated function libraries.

  • Built-in functions. Enables you to select any standard VBScript function supported by UFT One. For more details, see VBScript Reference.

  • Local script functions. Enables you to select any local function defined directly in the current action or function library.