Test Package XML Conventions

Test Sequence Definition XML File Tag Reference

<TestDefinition> —Top-level tag for .testdef files.

Table 5. <TestDefinition> Attributes

Attribute Name	Data Type	Required?	Accepted and Default Values	Description
Name	string	Yes	—	Unique name of the Test package file. Once defined, this name should never be changed. If DisplayName is not defined, this name is shown in the Test drop-down listbox in the Test Definition section of the BTS Web UI Test Plan Editor.
DisplayName	string	No	—	Display name of the Test. This name is shown in the Test drop-down listbox in the Test Definition section of the BTS Web UI Test Plan Editor.
Description	string	Yes	—	High-level description of the Test package file. This description is shown as an info tip in the Test Definition section of the Test Plan Editor in the BTS Web UI when the corresponding test is selected in the Test drop-down listbox.
SequenceFile	string	Yes	—	Location of primary top-level TestStand .seq file associated with test defined in .testdef file. The file path should be relative to the .testdef file.
TestMonitorPage.Plugin	string	No	—	Component name of a Test Monitor page plugin used in the Web UI for the Test package.
IsDeprecated	boolean	No	False	Indicates if the test package name should be included in the test sequence selector menu when creating a test plan.

<Parameters> —Tag which contains a list of all <Parameter> elements in a .testdef file.

<Parameter> —Tag which describes a test input parameter. Parameters are shown in the BTS Web UI to specify user input values to the test sequence.

Table 41. <Parameter> Attributes

Attribute Name	Data Type	Required?	Accepted and Default Values	Description
Name	string	Yes	—	Name of the parameter. This name is shown above the corresponding Parameter control in the Test Definition section of the BTS Web UI Test Plan Editor.
DisplayName	string	No	—	Display name for the parameter. This name is shown above the corresponding Parameter control in the Test Definition section of the BTS Web UI Test Plan Editor. If DisplayName is not provided, the Name is shown above the corresponding Parameter control.
Type	enum	Yes	Boolean Integer Double String Enum Profile	Type of data stored in the parameter. Changes the type of Parameter control displayed for a parameter in the Test Definition section of the BTS Web UI Test Plan Editor.
Default	Type-Dependent: Integer: int32 Boolean: boolean Double: double String: string Enum: enum Profile: string	No	Default: Integer: 0 Boolean: False Double: 0 String: "" Enum: First item in selection menu for Enum Parameter Profile: First item in selection menu for Profile Parameter Accepted: Integer: int32 value range Boolean: True, False Double: double value range String: any string Enum: any value specified in an <EnumValue> tag Profile: name of any profile specified in a <Profile> tag	Default value of the parameter. Changes the default value shown in a Parameter control in the Test Definition section of the BTS Web UI Test Plan Editor.
Min	Type-Dependent: Integer: int32 Double: double	No	null	Minimum value of the parameter. Only applies to Integer and Double parameters. If a value is input into an Integer or Double Parameter control that is below this value, the BTS Web UI will notify the user and not accept the value.
Max	Type-Dependent: Integer: int32 Double: double	No	null	Maximum value of the parameter. Only applies to Integer and Double parameters. If a value is input into an Integer or Double Parameter control that is above this value, the BTS Web UI will notify the user and not accept the value.
FileExtension	String	No	.*	File extension for a profile type file. Restricts the type of files that may be specified or selected as a profile.
TestDefinition Parameter. UIDisplayOrder	Double	No	undefined	If specified, this value orders the properties in the Test Parameter section of the BTS Web UI. The lower the value, the higher the parameter will be positioned in the parameter section. Properties with the same UIDisplayOrder value will be ordered alphabetically.

<EnumValue> —Tag which contains a valid enum value for an Enum <Parameter> element. Contained within an Enum <Parameter> element. values contained within <EnumValue> tags will appear in a drop-down listbox below a corresponding enum Parameter control in the Test Definition section of the BTS Web UI Test Plan Editor.

Note If no <EnumValue> tags are defined for an Enum <Parameter> tag, an error will be thrown when the XML file containing the Enum <Parameter> is loaded.

<ProfileSet> —Tag which contains a list of all <Profile> elements in a .testdef file.

<Profile> —Tag which describes a profile used to help parameterize the test sequence described in a .testdef file.

Table 42. <Profile> Attributes

Attribute Name	Data Type	Required?	Accepted and Default Values	Description
Name	string	Yes	—	Name of the profile. This name will appear in a Profile Parameter control's drop-down listbox in the Test Definition section of the BTS Web UI Test Plan Editor.
Path	string	Yes	—	Location of the test package's file structure relative to the .testdef file.
ProfileOption	string	No	none	Profile option for a profile type file. Restricts the list of profiles from the ProfileSet that will be included in this parameter's selector in the Web UI. If specified, only the profiles specified using ProfileOption will be included in the selector.

<Aliases> —Tag which contains a list of all <SocketAlias> and <SharedAlias> elements in a .testdef file.

<SocketAlias> —Tag which describes a signal alias. <SocketAlias> tags can contain a Measurement Attribute element, which contains information on the signal's properties. Measurement Attribute elements are described in Measurement Attribute XML Conventions.

<SharedAlias> —Tag which describes an alias in VeriStand and TestStand shared by multiple DUTs.

Table 8. <SocketAlias> and <SharedAlias> Attributes

Attribute Name	Data Type	Required?	Accepted and Default Values	Description
Name	string	Yes	—	Name of the signal alias in VeriStand and TestStand. This name will appear in the Endpoint Mappings section of the BTS Web UI. <SocketAlias> names will appear in the Test Channel list, while <SharedAlias> names will appear in the Shared Test Channel list.
SystemCompiler.AliasPathPrefix	string	No	—	System definition path to the signal alias prepended to the defined alias name.

Sample .testdef File

The following example illustrates a sample structure for a .testdef XML file.

<?xml version="1.0" encoding="utf-8" ?>
<TestDefinition
    Name="All Parameter Types"
    Description="Sample test definition with all 
    parameter types."
    SequenceFile="TestSequences\Main.seq"
    TestMonitorPage.Plugin="TestMonitorPluginA">
    <Parameters>
        <Parameter Name="Power" Type="Double" Min="0"
		Max="40" UIDisplayOrder="1" />
        <Parameter Name="Number" Type="Integer"
		Default="6" Min="0" Max="40"
		UIDisplayOrder="2" />
        <Parameter Name="Location" Type="String" 
         Default="Detroit" UIDisplayOrder="3" />
        <Parameter Name="RunImmediately" Type="Boolean" 
         UIDisplayOrder="4" />
        <Parameter Name="DriverProfile" 
         DisplayName="Driver Profile" Type="Profile" 
         FileExtension=".csv" Default="Profile2" 
         UIDisplayOrder="5" />
        <Parameter Name="Letter" Type="Enum" Default="A" 
         UIDisplayOrder="6">
            <EnumValue>A</EnumValue>
            <EnumValue>B</EnumValue>
        </Parameter>
    </Parameters>
   <ProfileSet>
        <Profile Name="Profile1" 
         Path="Profiles\Profile1.csv"/>
        <Profile Name="Profile2" 
         Path="Profiles\Profile2.csv"/>
    </ProfileSet>
    <Aliases>
        <SocketAlias Name="VoltageInput" 
         SystemCompiler.AliasPathPrefix="Test\
	  Socket %SOCKET%\" >
            <VoltageInputAttributes Unit="Voltage" 
             MinValue="0" MaxValue="10" 
             InputConfiguration="ReferencedSingleEnded" />
        </SocketAlias>
        <SharedAlias Name="Chamber set point" 
         SystemCompiler.AliasPathPrefix="Test\" />
    </Aliases>
</TestDefinition>