Edit Sequence Call Dialog Box

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Insert a step configured to use the Sequence Adapter and select Specify Module from the context menu to launch the Edit Sequence Call dialog box from a TestStand User Interface. You can also select Properties from the context menu. When you select Properties, you must click Specify Module in the Step Properties dialog box.

The Edit Sequence Call dialog box contains the following options:

  • Specify Expressions for Pathname and Sequence—Specifies whether you provide the sequence name and sequence file pathname using literal strings or expressions TestStand evaluates at run time. When you use literal strings, you enter the actual pathname of the sequence file in the File Pathname control. When you enable this option, you cannot use the Use Prototype of Selected Sequence option. When you use expressions, you specify an expression in the Sequence control.
    Note Note  If the Sequence Call step specifies the Preload when opening sequence file or Preload when execution begins load option, and you enable the Specify By Expression option for the step or the step calls a custom sequence file, TestStand does not preload the code module and behaves as if you selected the Load dynamically load option for the step.
  • Use Current File—TestStand calls a sequence in the sequence file you are currently editing. The File Pathname/File Path or Reference Expression control dims when you enable this option.
  • File Pathname/File Path or Reference Expression—The pathname of the sequence file or a reference to a SequenceFile object. When you use expressions, the File Path or Reference Expression control appears in place of the File Pathname control. Use this control to specify the expression for the sequence file pathname.
  • Client Pathname/Path or References—The pathname or reference of the client sequence filename when the step runs the sequence in a new execution and the Execution Settings dialog box specifies to use a process model. When you use expressions, use this option to specify an expression for the client sequence file.
  • Model Pathname/Path or Reference—The pathname or reference of the model sequence file when the step runs the sequence in a new execution and the Execution Settings dialog box specifies to use a process model. When you use expressions, use this option to specify an expression for the client sequence file.
  • Sequence—The name of the sequence in the sequence file you specify. When you use expressions, use this option to specify an expression for the sequence name.
  • Entry Point—The name of the entry point when the step runs the sequence in a new execution and the Execution Settings dialog box specifies to use a process model. When you use expressions, use this option to specify an expression for the entry point name.
  • Multithreading and Remote Execution—Specifies whether the sequence you call runs in a separate thread, in a separate execution, or on a remote computer. The following options are available in the ring control:
    • None—Specifies whether the sequence you call runs in the current thread.
    • Run Sequence in a New Thread—The sequence runs in a new a thread within the current execution. Threads in the same execution share the same report and the same result tree. In addition, all threads in an execution suspend or terminate when the execution suspends or terminates.
    • Run Sequence in a New Execution—The sequence runs in a new execution. Separate executions have separate reports and result trees. Suspending or terminating an execution does not affect other executions. Separate executions can also run under different process models.
    • Run Sequence on Remote Computer—The sequence runs on the remote computer you specify. To execute the sequence remotely, the Sequence Adapter connects to an instance of the TestStand Engine on the remote computer.
    Note  When you specify that a sequence runs in a new thread or execution, the status of the sequence call is Done or Error. This status is independent of the status of the sequence you call. To determine the status of an asynchronous subsequence from a step in the calling sequence, use a Wait step to wait for the asynchronous sequence to complete. The status of the Wait step is the status of the asynchronous sequence.
  • Settings—Launches a dialog box in which you can configure multithreading and remote execution settings. The dialog box varies according to the option you select in the Multithreading and Remote Execution ring control. The following options are available in the ring control:
    • Thread Settings—Specifies if the sequence you call runs in a new thread. Selecting this option launches the Thread Settings dialog box.
    • Execution Settings—Specifies if the sequence you call runs in a new execution. Selecting this option launches the Execution Settings dialog box.
    • Remote Execution Settings—Specifies if the sequence you call runs on a remote computer. Selecting this option launches the Remote Execution Settings dialog box.
      Note Note  TestStand does not support remotely executing a sequence across different TestStand versions, for example, remotely executing a TestStand 2013 sequence from a computer running TestStand 2010.
  • Parameters—The Parameters section contains the following items:
    • Use Prototype of Selected Sequence—Enable this option to specify to update the contents of the Parameters Table control whenever you select a different sequence from the Sequence ring control. This option is not available when you enable the Specify Expressions for Pathname and Sequence option. When this option is disabled, use the Load Prototype button to update the contents of the Parameters Table by selecting the parameters from an existing sequence.
    • Load Prototype—Loads a prototype from a sequence that has the same parameter list definition as the sequences the step might call. This button is available when you enable the Specify Expressions for Pathname and Sequence option. Use this button to update the contents of the Parameters Table when you enable the Specify Expressions for Pathname and Sequence option.
    • Parameters Table—Displays the parameters the step passes to the sequence. The contents of the Parameters Table control must be consistent with the parameter definitions in the sequence the step calls. You must extract the parameter definitions from the sequence or from another sequence that has the same parameter list.

      The Parameters Table control contains the following columns:

      • Name—A symbolic name for the parameter.
        Note Note  Parameters with attributes include an Edit Attributes button in the Name column of the Parameters Table. TestStand associates parameter attributes with the module parameter, which TestStand stores with the step configuration information, not with the parameter value that TestStand passes to the module. Right-click an item in the Parameters Table to access the Parameters Table context menu, from which you can launch the Attributes dialog box.
      • Type—The TestStand data type for the parameter.
      • Log—When you enable this option, the step logs the parameter as an additional result. Enabling this option is equivalent to using the checkbox next to the additional result name in the Additional Results dialog box. For in/out parameters, enabling this option enables the [In] parameter and the [Out] parameter in the Additional Results dialog box. This option is indeterminate for in/out parameters if you specify to log only the [In] parameter value or only the [Out] parameter value. If this option is indeterminate, a tooltip specifies whether the Additional Results dialog box specifies to log the [In] parameter value or the [Out] parameter value.
      • Use Default—When you enable this option, the step passes the default value the sequence defines for the parameter.
      • Value—The argument the step passes for a parameter. You can specify an expression TestStand evaluates at run time.
        Note Note  When you pass an array to a sequence, the Sequence Adapter does not alter the array bounds. For example, if a sequence defines a parameter with bounds [0..2] and a Sequence Call step passes an array with bounds [3..5], the called sequence must access the array with bounds [3..5], not [0..2].
      • How Passed—Specifies whether the step passes the parameter by value or by reference. When the step passes the parameter by reference, the subsequence can change the value of the parameter argument. The parameter definition in the sequence determines whether the step passes the argument by value or by reference.

      Although the parameter list the step uses must be consistent with the parameter list the sequence defines, the step can specify fewer parameters than the sequence specifies. The data types for the parameters in the step must be compatible with the corresponding parameters in the sequence. The Sequence Adapter uses the default values for the parameters the step does not pass explicitly.

      When you use the Load Prototype button on the Module tab of the Step Settings pane of a Sequence Call step to load prototype information from a different sequence and the sequence from which you load the prototype includes the same parameters as the original sequence plus additional parameters, TestStand passes the additional parameters to the sequence you call.

    Note  When you call a sequence on a remote host, you can pass single-valued properties or arrays of number, Boolean, and string properties by value or by reference. You can also pass container properties or object reference properties to a remote sequence if the receiving parameter type is an object reference property.

See Also

Additional Results dialog box

Attributes dialog box

Built-In Step Types

Execution Settings dialog box

Parameters Table Context Menu for Specify Module Dialog Boxes

Remote Execution in 32-bit TestStand and 64-bit TestStand

Remote Execution Settings dialog box

Sequence File Translators

SequenceFile

Step Properties dialog box

Thread Settings dialog box

WAS THIS ARTICLE HELPFUL?

Not Helpful