Sequence Call Module Tab

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

To display the Sequence Call Module edit tab in the TestStand Sequence Editor, insert a Sequence Call step or configure a step to use the Sequence Adapter and select Specify Module or Step Settings from the context menu. The Sequence Call Module edit tab contains the following options:

  • File Pathname—The pathname of the sequence file or a reference to a SequenceFile object. This option is available only when you disable the Specify By Expression option.
  • File Path or Reference—The expression for the sequence file pathname. This control is available only when you enable the Specify By Expression option and takes the place of the File Pathname control.
  • 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.
  • Sequence Comment—The comment associated with the sequence that the step calls.
  • Client Path or Reference—The pathname or reference of the client sequence filename when the step runs the sequence in a new execution and the Execution Settings specifies to use a process model. This control is available only when you select Use New Execution in Execution Options.
  • File Path or Reference—The expression for the client sequence file. This control is available only when you enable Specify By Expression and takes the place of the Client Path or Reference control when you select Use New Execution in Execution Options.
  • Model Pathname—The pathname or reference of the model sequence file when the step runs the sequence in a new execution and the Execution Settings specifies to use a process model. When you use expressions, use this option to specify an expression for the client sequence file. This control is available only when you select Use New Execution in the Execution Options control of the Sequence Call Advanced Settings window.
  • Model Path or Reference—An expression for the client sequence file. This control is available only when you select Use New Execution in Execution Options and enable Specify By Expression. This control takes the place of the Model Pathname control.
  • 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. This control is available only when you select Use New Execution in Execution Options.
  • Entry Point Comment—The comment associated with the entry point sequence that the step calls.
  • Specify By Expression—Enable this option to specify that the sequence name and sequence file pathname are expressions that 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 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—When you enable this option, the step calls a sequence in the sequence file you are currently editing. The File Pathname or File Path or Reference control dims when you enable this option.
  • Execution Options—Launches a floating pane in which you can configure multithreading and remote execution settings. The floating pane varies according to the selection you make in the Execution Options ring control. The following options are available in the ring control:
    • None—Calls the sequence synchronously without using a new thread or execution. The calling sequence waits until the called sequence completes. This is the default setting.
    • Use New Thread—Runs the sequence in a new thread.
    • Use New Execution—Runs the sequence in a new execution.
    • Use Remote Computer—Runs the sequence on a remote computer.
      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.
  • Use Prototype of 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 by Expression 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. Use this button to update the contents of the Parameters Table when you enable the Specify By Expression option.
  • Parameters—The Parameters section contains the following items:
    • 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 on the Additional Results panel of the Properties tab of the Step Settings pane. For in/out parameters, enabling this option enables the [In] parameter and the [Out] parameter on the Additional Results panel. 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 panel 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. If 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.
      • Comment—The comment associated with the parameter for the sequence that the step calls.

      Although the parameter list the step uses must be consistent with the parameter list the sequence defines, the step can specify fewer or more 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. The Sequence Adapter passes additional parameters if the step defines more parameters than the sequence specifies.

      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

Attributes dialog box

Built-In Step Types

Parameters Table Context Menu for Module Tabs

Sequence Call Advanced Settings Window

Sequence File Translators

SequenceFile

Step Settings Pane

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

WAS THIS ARTICLE HELPFUL?

Not Helpful