Legacy Property Loader Step

TestStand 2016 Help

Edition Date: August 2016

Part Number: 370052R-01

»View Product Info
Download Help (Windows Only)

Use the Legacy Property Loader step to dynamically load property and variable values from a text file, a Microsoft Excel file, or a database management system (DBMS) at run time.

Notes Notes
  • In TestStand 2016 and later, the Legacy Property Loader step is no longer listed in the default type palettes installed by TestStand. If you open a sequence file with a legacy step, the legacy step type will appear in the insert step menu, and you can still execute sequences that contain the legacy Property Loader steps. The Legacy Import/Export Properties tool in the Tools menu is not installed by default. You can manually add the legacy tool by importing the <TestStand> \Components\StepTypes\Database\LegacyImportExportTool.ini file in the Tools menu. See the Importing and Exporting with a Legacy Source topic for more information.
  • The Legacy Property Loader step type supports only ANSI file formats.

The Property Loader step type can load limits from all TestStand-supported databases except MySQL. You can apply the values you load to the current sequence. For example, you can develop a sequence that tests two different models of a cellular phone, where each model requires unique limit values for each step. When you use step properties to specify the limit values, include a Property Loader step in the Setup step group of the sequence to initialize the property and variable values each time before the steps in the Main step group execute.

You can also load values for properties into sequences so that all subsequent invocations of the sequences in the file use the dynamically loaded property values. For example, include a Property Loader step in a ProcessSetup model callback sequence the execution calls once so the execution can call the client sequence file multiple times with the dynamically loaded property values.

Configuring the Step

Use the Edit Property Loader dialog box in the TestStand Sequence Editor and in a TestStand User Interface to configure the Property Loader step.

Step Properties

In addition to the common custom properties, the Property Loader step type defines the following step properties:

  • Step.Result.NumPropertiesRead—The total number of values the step loaded from the file or database.
  • Step.Result.NumPropertiesApplied—The total number of values the step assigned to properties or variables. A number less than the value of the Step.Result.NumPropertiesRead property indicates the step was unable to update properties or variables.
  • Step.ColumnListSource—The name of the DatabaseColumnValue array variable or property that stores the list of column comparisons you use to filter the rows in a database recordset. By default, the value is Step.ColumnList.
  • Step.ColumnList—The column comparisons TestStand makes on a recordset before TestStand loads recordset values into a property. The property must be an array of DatabaseColumnValue custom data types, which contain the following subproperties:
    • ColumnName—The name or number of the column on which to perform the comparison.
    • Data—The expression TestStand evaluates at run time to compare against the column value.
    • FormatString—An optional format string for dates, times, and currencies. Use the empty string ("") to use the default format.
    • Direction—An enumerated value that specifies the parameter direction as In, Out, In/Out, or Return.
    • Type—An enumerated value that specifies the parameter type as String, Number, Boolean, or Date/Time.
    • Size—The maximum size of a string parameter.
    • WriteNull—Not used.
    • Status—Not used.
  • Step.PropertiesListSource—The name of the DatabasePropertyMapping array variable or property that stores the list of variables and properties in which to load data. By default, the value is Step.PropertiesList.
  • Step.PropertiesList—The list of variables and properties in which to load data. The list must be an array of DatabasePropertyMapping custom data types. Each element of the array defines a mapping of source data to a TestStand variable or property. The DatabasePropertyMapping custom data type contains the following subproperties:
    • PropertyName—The name of the property or variable to which TestStand assigns a value.
    • PropertyType—The scope of the property or variable. Valid values are 0 = Step, 1 = Local, 2 = File Global, and 3 = Station Global.
    • DataType—The TestStand type of the property. Valid values are 1 = String, 2 = Boolean, and 3 = Number.
    • ColumnName—The name of the column from which TestStand obtains the value.
  • Step.DataSourceType—Specifies where the step imports property values from. Valid values are 2 = File and 3 = Database.
  • Step.Database—The SQL statement handle and settings for importing property values from a database to a sequence file. The Database step property contains the following subproperties:
    • SQLStatementHandle—The name of the variable or property that contains the SQL statement handle the step uses at run time to load values.
    • SQLStatement—The SQL statement the Edit Property Loader dialog box uses to populate ring controls that contain column names.
    • StepNameColumn—The name of the column in the recordset that contains the names of the steps and variable scopes that define the rows of data.
    • AppendTypeName—Specifies whether TestStand appends the data type name of the property to the column name when selecting a property from the available list.
    • FilterUsingColumnList—Specifies whether the step loads only the rows that match the specific column value.
    • MaxColumnSize—The maximum number of characters for a column name.
  • Step.File—The file and settings for importing property values from a file to a sequence file. The File step property contains the following subproperties:
    • Path—A literal pathname for the data file.
    • DecimalPoint—The type of decimal point the file uses.
    • UseExpr—Specifies whether TestStand uses Step.File.Path or Step.File.FileExpr for the pathname of the data file.
    • FileExpr—A pathname expression TestStand evaluates at run time.
    • Format—The type of delimiters in the file and the file type. Valid values are Tab, Comma, or Excel.
    • Start.MarkerExpr—The expression for the starting marker.
    • EndMarkerExpr—The expression for the ending marker.
    • Skip—The string that causes the step type to ignore the row when the string appears at the beginning of the row.
    • MapColumnsUsingFirstRow—Specifies whether the first row of each data block in the data file contains the names of the step properties into which the step loads the property values.
    • ColumnMapping—The names of the properties into which the step loads the values when Step.File.MapColumnsUsingFirstRow is False.
  • Step.SequenceFile—The path to the sequence file to import properties to.
  • Step.Sequence—The sequence to which the step imports properties.
  • Step.ExpandToRelatedExecutions—Specifies that TestStand applies imported property values to sequences running in related executions, which include the original execution and all executions TestStand invoked or invokes using a Sequence Call step.
  • Step.UseCurrentSequence—Specifies to import properties to the run-time copy of the sequence that includes the step. Otherwise, imported properties apply to all invocations of the sequences the step imports to.
  • Step.UseCurrentFile—Specifies to import properties to the sequence file that includes the step.
  • Step.ImportAll—Specifies whether the step attempts to import all property values listed in a file into the selected sequence files.
  • Step.StartMarkerMissingAction—Specifies the action the step takes when TestStand does not find the start marker in the file. Valid values are 1 = Stop and error and 2 = Skip sequence.

WAS THIS ARTICLE HELPFUL?

Not Helpful