Naming conventions

Relevant for: GUI tests and components and API testing

The following table lists the restrictions to consider when naming items in UFT:

Item

Naming Convention

Action
(for GUI tests)

  • Must be unique in the test.

  • Cannot be named Global, since Global is the name reserved for the Global sheet in the Data pane.

    If you create an action called Global, you will not be able to select the local or global data sheet when parameterizing a description property.

  • Cannot begin or end with a space.

  • Cannot contain the following characters: \ / : * ? " < > | % ' ! { }

Action parameter
(for tests)

  • Case-sensitive.

  • Must begin with a letter

  • Cannot contain spaces.

  • Cannot contain the following characters: ! @ # $ % ^ & * ( ) + = [ ] \ { } | ; ' : " , . / < >

Action
(for API tests)
  • Cannot begin or end with a space

  • Cannot exceed 1,023 characters

  • Cannot contain the following characters: \ / : * ? " < > | % ' ! { }

Application area
(for components)

  • Cannot exceed 220 characters (including the path).

  • Cannot contain, begin, or end with spaces.

  • Cannot contain the following characters: \ / : " ? < > | * ! { } ' % ; ,

  • Cannot contain multibyte punctuation symbols and other multibyte special characters, such as multibyte question marks, multibyte spaces, and multibyte brackets.

Component parameter
  • Cannot contain brackets in the name (e.g. {Param1})

Checkpoint

  • Cannot begin or end with a space.

  • Cannot contain " (double quotation mark).

  • Cannot contain the following character combinations:

    • :=

    • @@

Component
(for components)

  • Cannot exceed 220 characters (including the path).

  • Cannot contain, begin, or end with spaces.

  • Cannot contain the following characters: \ / : " ? < > | * ! { } ' % ;

  • Cannot contain multibyte punctuation symbols and other multibyte special characters, such as multibyte question marks, multibyte spaces, and multibyte brackets.

Data Table file
(for tests and scripted components)

ALM: cannot contain the following characters: ! % * { } \ | ' : " / < > ? ; ,

Data Table > Parameter name (column header)

(for tests and scripted components)

  • Must be unique in the sheet.

  • Must begin with a letter or underscore.

  • Can only contain the following:

    • Letters (excluding special characters, machine-dependent characters, or platform-dependent characters)

    • Numbers

    • Periods

    • Underscores

Environment variable (parameter)

  • Must begin with a letter.

  • Can only contain the following:

    • Letters

    • Numbers

    • Underscores

Environment variables file

File system: Cannot contain the following characters: ! % * { } \ | ' : " / < > ? ;

ALM: Cannot contain the following characters: ! % * { } \ | ' : " / < > ? ; ,

Function library file

File system: Cannot contain the following characters: ! % * { } \ | ' : " / < > ? ;

ALM:

  • Cannot contain the following characters: ! % * { } \ | ' : " / < > ? ; ,

  • Cannot contain non-English characters

Function / Function argument

  • Cannot contain non-English letters or characters.

  • Function names cannot be the same as a VBScript registered keyword.
  • Must begin with a letter.

  • Cannot contain spaces or any of the following characters: ! @ # $ % ^ & * ( ) + = [ ] \ { } | ; ' : "" , / < > ?

Object repository file

File system: Cannot contain the following characters: ! % * { } \ | ' : " / < > ? ;

ALM: Cannot contain the following characters: ! % * { } \ | ' : " / < > ? ; ,

Output value

  • Cannot begin or end with a space.

  • Cannot contain " (double quotation mark).

  • Cannot contain the following character combinations:

    • :=

    • @@

ALM file or folder name

  • Cannot exceed 90 characters (including the path).

  • Cannot begin or end with a space.

  • Cannot contain the following characters: \ : * ? " < > | % ' ;

  • Cannot contain multibyte punctuation symbols and other multibyte special characters, such as multibyte question marks, multibyte spaces, and multibyte brackets.

Recovery Scenario

File system: Cannot contain the following characters: ! % * { } \ | ' : " / < > ? ;

ALM: Cannot contain the following characters: ! % * { } \ | ' : " / < > ? ; ,

Test name
(for tests)

  • Cannot exceed 220 characters (including the path).

    When you create a test and store it in the file system, UFT creates a folder with the name you specify, and also a file with the same name inside that folder.

    The name of this file, including its path, cannot exceed 220 characters.

  • Cannot begin or end with a space.

  • Cannot contain the following characters: \ / : * ? " < > | % ' ;

  • Cannot contain multibyte punctuation symbols and other multibyte special characters, such as multibyte question marks, multibyte spaces, and multibyte brackets.

Test resources
(when saving a test with resources)
The path name (resource name and file path together) cannot exceed 256 characters.

Test object class (extensibility only)

  • Cannot contain non-English letters or characters.

  • Cannot contain spaces or any of the following characters: ! @ # $ % ^ & * ( ) + = - [ ] \ { } | ; ' : "" , / < > ?

Test object name

  • must be unique within the same class and hierarchy in the object repository

  • Cannot begin or end with a space.

  • Cannot contain " (double quotation mark).

  • Cannot contain the following character combinations:

    • :=

    • @@

  • Limited to 30 characters when generated from Navigate and Learn

Test object description properties

  • Cannot contain non-English letters or characters.

  • Cannot contain spaces or any of the following characters: ! @ # $ % ^ & * ( ) + = [ ] \ { } | ; ' : "" , / < > ?

Test object method / Test object method argument

  • Cannot contain non-English letters or characters.

  • Cannot contain spaces or any of the following characters: ! @ # $ % ^ & * ( ) + = [ ] \ { } | ; ' : "" , / < > ?