TestingEnvironment Schema
TypeInformation Element
TestingEnvironment Schema : TypeInformation Element
Description
The top level element that defines the testing environment and contains the test object classes (ClassInfo elements) and predefined lists of values (ListOfValues elements).
Namespace(none)
Diagram
RecordSuppression ElementListOfValues ElementClassInfo ElementSequenceTypeInformation Element
Overview
TypeInformation
The top level element that defines the testing environment and contains the test object classes (ClassInfo elements) and predefined lists of values (ListOfValues elements).
Priority optional xs:integer
The priority of the test object classes defined in this XML.
Load optional xs:boolean
Specifies whether this testing environment definition should be loaded.
PackageName required xs:string
The name used to identify the testing environment uniquely. Also referred to as the environment ID.
Version optional xs:decimal
The version of this testing environment definition.
Description optional xs:string
A description of the testing environment defined in this XML.
AddinName required xs:string
The testing environment's display name, used in UFT dialog boxes that display lists of add-ins and supported environments.
Sequence
ClassInfo 1..∞
The test object class.
Name required xs:string
The name of the test object class.
BaseClassInfoName optional xs:string
The name of the base test object class.
GenericTypeID optional xs:string
The generic type of the ClassInfo.
DefaultOperationName optional xs:string
The default operation of the ClassInfo.
FilterLevel optional xs:integer
The filter level of the test object class.
ROTypeInfo optional xs:boolean
Specifies whether UFT should use the TypeInfo information from the actual object in the object repository and not from the XML.
SupportsTabularData optional xs:boolean
Indicates whether objects of this class support table data.
Withable optional xs:boolean
Indicates whether objects of this class can be referenced without full specification inside a WITH block.
Sequence
Description optional xs:string
The description of the element.
HelpInfo optional
Context-sensitive Help information for the element.
HelpFile required xs:string
The file system path to the file which contains the help information.
HelpContext optional xs:integer
The context identifier for the location inside the help file where the information resides.
IconInfo optional
Icon information for the element.
IconFile required xs:string
The file system path to the file which contains the icon. Can be a dll, exe, or ico file.
IconIndex optional xs:integer
The index to the location of the icon inside the dll or exe.
TypeInfo optional
Type information for a test object class, including the location of the external type library and a list of additional operations.
Sequence
ExternalTypeInfo optional
External type library information for the test object class.
TypeLibraryPath required xs:string
The file system path to the type library file.
CLSID required xs:string
The class id of this ClassInfo. Used to locate the type information inside the type library.
Operation 0..∞
A single method or property of a test object class.
Name required RestrictedString Simple Type
The name of the operation.
PropertyType optional Restriction of PropertType Simple Type
The operation type. Either Method or up to three Property specifications.
ExposureLevel optional Restriction of xs:string
Specifies the exposure level of the operation. It can be common used and exposed to all users, or exposed only to experts.
SortLevel optional xs:integer
The sort level of the operation. Numbers below zero move the item up in the list. Numbers above zero move the item down.
Sequence
Description optional xs:string
The description of the element.
Documentation 0..∞ Extension of xs:string
The documentation string for the operation.
NumOfArguments optional xs:integer
The number of arguments that require values to be specified in order to show the documentation string for the operation.
HelpInfo optional
Context-sensitive Help information for the element.
HelpFile required xs:string
The file system path to the file which contains the help information.
HelpContext optional xs:integer
The context identifier for the location inside the help file where the information resides.
IconInfo optional
Icon information for the element.
IconFile required xs:string
The file system path to the file which contains the icon. Can be a dll, exe, or ico file.
IconIndex optional xs:integer
The index to the location of the icon inside the dll or exe.
Argument 0..∞
The argument definitions for the operation.
Name required RestrictedString Simple Type
The argument name.
IsMandatory required xs:boolean
Specifies whether the argument is mandatory.
DefaultValue optional xs:string
The default value for this argument.
Direction optional Restriction of xs:string
Specifies whether this argument is an input argument or an output argument.
Sequence
Type
The data type.
VariantType optional Variant Simple Type
The variant type of the argument.
ListOfValuesName optional xs:IDREF
The name of the list of values of the argument. Can be one of the list of values names defined in this XML.
Description optional xs:string
The description of the element.
HelpInfo optional
Context-sensitive Help information for the element.
HelpFile required xs:string
The file system path to the file which contains the help information.
HelpContext optional xs:integer
The context identifier for the location inside the help file where the information resides.
AdditionalInfo optional
Placeholder for additional information.
ReturnValueType optional
The return value's data type.
Sequence
Type
The data type.
VariantType optional Variant Simple Type
The variant type of the argument.
ListOfValuesName optional xs:IDREF
The name of the list of values of the argument. Can be one of the list of values names defined in this XML.
AdditionalInfo optional
Placeholder for additional information.
AdditionalInfo optional
Placeholder for additional information.
AdditionalInfo optional
Placeholder for additional information.
Properties optional
The collection of identification properties for the test object class.
Sequence
Property 1..∞
An identification property for the test object class.
Name required RestrictedString Simple Type
The property name.
ForVerification optional xs:boolean
Indicates if the property can be used for verification in a Checkpoint.
ForDefaultVerification optional xs:boolean
Indicates if the property is used by default for verification in a Checkpoint.
ForDescription optional xs:boolean
Indicates if the property is used in constructing the object description.
Sequence
Type
The data type.
VariantType optional Variant Simple Type
The variant type of the argument.
ListOfValuesName optional xs:IDREF
The name of the list of values of the argument. Can be one of the list of values names defined in this XML.
Description optional xs:string
The description of the element.
ListOfValues 0..∞
A predefined list of values that can be used for test object method arguments or return values.
Name required xs:ID
The name of the list of values. This name can be used as an argument type.
Sequence
Description optional xs:string
The description of the element.
HelpInfo optional
Context-sensitive Help information for the element.
HelpFile required xs:string
The file system path to the file which contains the help information.
HelpContext optional xs:integer
The context identifier for the location inside the help file where the information resides.
EnumValue 1..∞
A possible value in a predefined list of values.
Name required RestrictedString Simple Type
HelpContext optional xs:integer
RealValue required xs:integer
Sequence
Description optional xs:string
The description of the element.
RecordSuppression optional
The collection of objects whose events are not to be recorded.
Choice 1..∞
ActiveX
An ActiveX object whose events are not to be recorded.
ProgID required xs:string
Window
A Windows object whose events are not to be recorded.
WindowClass required xs:string
Attributes
NameTypeUseDefaultFixedDescription
Priorityxs:integeroptional0 The priority of the test object classes defined in this XML.
Loadxs:booleanoptionaltrue Specifies whether this testing environment definition should be loaded.
PackageNamexs:stringrequired  The name used to identify the testing environment uniquely. Also referred to as the environment ID.
Versionxs:decimaloptional1.0 The version of this testing environment definition.
Descriptionxs:stringoptional  A description of the testing environment defined in this XML.
AddinNamexs:stringrequired  The testing environment's display name, used in UFT dialog boxes that display lists of add-ins and supported environments.
Source
<xs:element name="TypeInformation" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>The top level element that defines the testing environment and contains the test object classes (ClassInfo elements) and predefined lists of values (ListOfValues elements).</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="ClassInfo" maxOccurs="unbounded"  />
      <xs:element ref="ListOfValues" minOccurs="0" maxOccurs="unbounded"  />
      <xs:element name="RecordSuppression" minOccurs="0">
        <xs:annotation>
          <xs:documentation>The collection of objects whose events are not to be recorded. </xs:documentation>
        </xs:annotation>
        <xs:complexType>
          <xs:choice maxOccurs="unbounded">
            <xs:element name="ActiveX">
              <xs:annotation>
                <xs:documentation>An ActiveX object whose events are not to be recorded. </xs:documentation>
              </xs:annotation>
              <xs:complexType>
                <xs:attribute name="ProgID" type="xs:string" use="required"></xs:attribute>
              </xs:complexType>
            </xs:element>
            <xs:element name="Window">
              <xs:annotation>
                <xs:documentation>A Windows object whose events are not to be recorded. </xs:documentation>
              </xs:annotation>
              <xs:complexType>
                <xs:attribute name="WindowClass" type="xs:string" use="required"  />
              </xs:complexType>
            </xs:element>
          </xs:choice>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
    <xs:attribute name="Priority" type="xs:integer" default="0">
      <xs:annotation>
        <xs:documentation>The priority of the test object classes defined in this XML.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="Load" type="xs:boolean" use="optional" default="true">
      <xs:annotation>
        <xs:documentation>Specifies whether this testing environment definition should be loaded.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="PackageName" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation>The name used to identify the testing environment uniquely. Also referred to as the environment ID.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="Version" type="xs:decimal" use="optional" default="1.0">
      <xs:annotation>
        <xs:documentation>The version of this testing environment definition.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="Description" type="xs:string" use="optional">
      <xs:annotation>
        <xs:documentation>A description of the testing environment defined in this XML. </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="AddinName" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation>The testing environment's display name, used in UFT dialog boxes that display lists of add-ins and supported environments.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>
</xs:element>
See Also