Library /sys$common/syshlp/helplib.hlb  —  DTM  CREATE

1  –  COLLECTION

   Designates a set of tests as a collection.

   Format

     CREATE COLLECTION  collection-name test-group-expression

          [/qualifier...] "remark"

1.1  –  Command Qualifiers

1.1.1    /BENCHMARK_DIRECTORY

   /BENCHMARK_DIRECTORY=directory-specification
   /NOBENCHMARK_DIRECTORY

   Determines whether Digital Test Manager should search the default
   benchmark directory for benchmark files for the specified
   collection.

   If you do not include a directory, Digital Test Manager searches the
   default benchmark directory for the benchmark file established by
   the SET BENCHMARK_DIRECTORY command.

   If you include a directory in the benchmark file specification
   for a test within the collection, Digital Test Manager searches that
   directory for the benchmark file and (if found) overrides the
   default directory. The directory you specify can be either another
   directory or a CMS library.

   The /NOBENCHMARK_DIRECTORY qualifier overrides the default
   benchmark directory for the specified collection. Digital Test Manager
   searches your default directory for all benchmark files without
   directory specifications.

1.1.2    /CLASS

   /CLASS=(keyword=class-name,...)

   Specifies the optional CMS class for benchmark files and template
   files stored in CMS libraries. The keywords, BENCHMARK and
   TEMPLATE, designate the name of the specific set of generations of
   elements. If you do not specify a class and the file is stored in
   a CMS library, the latest generation on the main line of descent
   is used.

   You can specify the same class names for your benchmark and
   template files. If you specify both keywords, separate them with a
   comma and enclose the list in parentheses. If you specify only one
   keyword, omit the parentheses.

1.1.3    /COMPARE

   /COMPARE[=(keyword,...)]
   /NOCOMPARE

   Determines whether Digital Test Manager compares the results of each
   test with its benchmark file (the file that contains expected
   test results) after the collection is executed. The default is
   /COMPARE.

   The /COMPARE qualifier specifies that Digital Test Manager is to
   compare all tests after the collection is executed. A collection
   must be compared before it can be reviewed. Any differences
   between the results for a test and its benchmark file are recorded
   in a difference file for that test. Tests without benchmarks can
   be compared, but will be marked with the comparison status of new
   test.

   When you review tests, you can have benchmark files generated for
   them. When you enter the /COMPARE qualifier, the COMPARE command
   default qualifiers (/SCREENS, /LOG, and /WIDTH=132) are in effect.
   You can optionally specify any of the following COMPARE command
   qualifiers as keywords:

     CHARACTERS
     FULL
     IGNORE=keyword
     [NO]PARALLEL
     RECORDS
     SCREENS
     WIDTH

   The /COMPARE qualifier keywords have the same effect as the
   COMPARE command qualifiers. See the COMPARE command qualifiers
   for a description of the /COMPARE qualifier keywords.

   If you specify more than one keyword, separate the keywords with
   commas and enclose the list in parentheses. If you specify only
   one keyword, you can omit the parentheses.

   The /NOCOMPARE qualifier prevents the automatic comparison that
   Digital Test Manager ordinarily performs when the collection is
   executed. You can use the COMPARE command later to compare test
   results for collections created with the /NOCOMPARE qualifier.

1.1.4    /EPILOGUE

   /EPILOGUE=file-specification
   /NOEPILOGUE

   Determines whether the default collection epilogue is run with
   this collection.

   The /EPILOGUE qualifier overrides the default collection epilogue
   file for this collection. The /NOEPILOGUE qualifier runs a
   collection without a collection epilogue. This qualifier has no
   effect on individual test epilogues.

1.1.5    /LOG

   /LOG (D)
   /NOLOG

   Controls whether Digital Test Manager displays informational and
   success messages on your screen.

1.1.6    /MASK

   /MASK=(keyword,...)

   The /MASK qualifier selects one or more sets of mask patterns that
   will cause certain run-time data to be ignored during the comparison
   of screens for interactive terminal tests.  Such run-time data is
   ignored by substituting blank space for patterns in both the
   benchmark and result screens before they are compared.

   The valid values for keyword are as follows:

     Keyword       Mask

     ALL           Specifies that all the masks in this table be used

     DATE          The date mask ignores comparison of date stamps

                   The following list shows some examples of the date
                   patterns to be ignored;  this list is not all
                   inclusive.

                     dd-mmm-yyyy     ( example: 17-OCT-1998 )
                     dd mmm yy       ( example: 17 OCT 98 )
                     yy.mmm.dd       ( example: 98.OCT.17 )
                     mm/dd/yy        ( example: 10/17/98 )
                     yyyy/mm/dd      ( example: 1998/10/17 )
                     month day, year ( example: October 17, 1998 )
                     month day, year ( example: Oct. 17, 1998 )
                     day.month.year  ( example: 17.October.1998 )
                     year-month-day  ( example: 98-October-17 )

     TIME          Ignores time stamps with the following forms:

                     hh:mm:ss.xxxx   ( example: 15:37:53.22 )
                     hh:mm:ss        ( example: 15:37:53 )
                     hh:mm           ( example: 15:37 )
                     hh:mm xm        ( example: 3:37 PM )
                     hhHmmm          ( example: 15H37m )
                     hhHmm'          ( example: 15H37' )
                     hh.mm h         ( example: 15.37 h )
                     hh h mm"ss s    ( example: 15 h 37"53 s )
                     hh h mm min     ( example: 15 h 37 min )
                     kl hh.mm        ( example: kl 15.37 )
                     h hh.mm         ( example: h 15.37 )

     VERSION       Ignores file versions on file names

     FILE_NAMES    Ignores file names of the form FILENAME.EXT

     DIRECTORIES   Ignores directory specification fields of
                   the form DISK:[DIRECTORY]

   If you specify more than one keyword, separate the keywords with
   commas and enclose the list in parentheses. If you specify only
   one keyword, omit the parentheses.  Masking of is performed in
   the order of the keywords shown above.

1.1.7    /PROLOGUE

   /PROLOGUE=file-specification
   /NOPROLOGUE

   Determines whether the default collection prologue is run with
   this collection.

   The /PROLOGUE qualifier overrides the default collection prologue
   file for this collection. The /NOPROLOGUE qualifier runs a
   collection without a collection prologue file. This qualifier
   has no effect on individual test prologues.

1.1.8    /REALTIME

   /REALTIME
   /NOREALTIME (D)

   Specifies that the speed of session file playback for all
   interactive terminal tests in the collection is to be based
   solely on the speed at which they were recorded and not on the
   rate at which the applications being tested request input.
   This qualifier is useful for testing applications that request
   input before completing processing and display of data.

1.1.9    /SENTINEL

   /SENTINEL=("begin-delimiter","end-delimiter")

   Specifies a pair of strings used to delimit a section of text to
   be ignored during the comparison of result and benchmark files for
   a noninteractive test. The delimiters can be up to 256 characters
   per line, and must be unique. Any text between and including the
   delimiters is treated as if it did not exist.

   If you do not enclose the sentinel strings in quotation marks,
   they are converted to uppercase before the comparison of the
   files. Sentinel strings may contain any characters, but if you
   include spaces, tabs, or commas they must be enclosed in
   quotation marks.

1.1.10    /SUBMIT

   /SUBMIT[=(keyword,...)]
   /NOSUBMIT (D)

   Determines whether the collection is executed immediately after it
   is created. You can submit collections that contain DECwindows
   tests but Digital Test Manager must be connected to a DECwindows
   server for the tests to execute.

   The /SUBMIT qualifier executes the collection in batch mode
   immediately after the collection is created. When you enter the
   /SUBMIT qualifier, the SUBMIT command qualifiers (/KEEP
   and /LOG) are in effect. You can optionally specify any of the
   following SUBMIT command qualifiers as keywords:

     AFTER        [NO]CHARACTERISTICS   CPUTIME

     [NO]HOLD     [NO]KEEP              [NO]LOG_FILE

     NAME         [NO]NOTIFY            [NO]PRINTER

     PRIORITY     QUEUE                 [NO]USER

     WSDEFAULT    WSEXTENT              WSQUOTA

   If you specify more than one keyword, separate the keywords with
   commas and enclose the list in parentheses. If you specify only
   one keyword, you can omit the parentheses.

   The /NOSUBMIT qualifier creates the collection without submitting
   it to the batch queue. To run the collection, use the SUBMIT
   command.

1.1.11    /TEMPLATE_DIRECTORY

   /TEMPLATE_DIRECTORY=directory-specification
   /NOTEMPLATE_DIRECTORY

   Determines whether Digital Test Manager should search the default
   template directory for template files for the specified
   collection.

   If you do not include a directory, Digital Test Manager searches the
   default template directory for the template file established by
   the SET TEMPLATE_DIRECTORY command.

   If you include a directory in the template file specification
   for a test within the collection, Digital Test Manager searches that
   directory for the template file. The directory you specify can be
   either another directory or a CMS library.

   The /NOTEMPLATE_DIRECTORY qualifier overrides the default template
   directory for the specified collection. Digital Test Manager searches
   your default directory for all template files without directory
   specifications.

1.1.12    /VARIABLE

   /VARIABLE=(variable-name=variable-value,...)

   Overrides the values of the specified global variables for
   this collection. If you override the value for more than one
   variable, separate the variables with commas and enclose the
   list in parentheses. If you override only one variable, omit the
   parentheses.

1.1.13    /VERIFY

   /VERIFY (D)
   /NOVERIFY

   Specifies whether Digital Test Manager is to verify the existence of
   files associated with all test descriptions before creating the
   collection. If a referenced file does not exist, Digital Test Manager
   does not create the collection.

   The /NOVERIFY qualifier causes Digital Test Manager to create the
   collection without verifying the existence of files associated
   with all test descriptions before creating the collection. If
   a file associated with a test description is missing when a
   collection executes, Digital Test Manager may not run that test.

1.2  –  Parameter Qualifiers

1.2.1    /GROUP

   Identifies the immediately preceding item in the test group
   expression as a group. If a test group expression is a list,
   use this qualifier after each item in the list that designates
   a group. The default is /TEST_DESCRIPTION.

1.2.2    /TEST_DESCRIPTION

   Identifies the immediately preceding item in the test group
   expression as a test expression. This is the default.

1.3  –  Examples

   1.  DTM> CREATE COLLECTION MAIL_COLL MAIL*/NOPROLOGUE
       _Remark: Tests of MAIL commands
       %DTM-S-CREATED, collection MAIL_COLL created
       DTM>

   This example creates the collection MAIL_COLL. It uses a
   qualifier to specify that there is to be no collection prologue
   file associated with this collection, and uses wildcards to
   specify which tests go into the collection.

   2.  DTM> CREATE COLLECTION MAIL_PLUS MAIL*, -
       _DTM> SEND_NONINT/GROUP
       _Remark: More MAIL tests
       %DTM-S-CREATED, collection MAIL_PLUS created
       DTM>

   This example creates the collection MAIL_PLUS. The test group
   expression specifies all tests that begin with MAIL, and all
   tests in the group SEND_NONINT at the time the collection is
   created.

2  –  GROUP

   Creates a group in the Digital Test Manager library.

   Format

     CREATE GROUP  group-name [/qualifier] "remark"

2.1  –  Command Qualifier

2.1.1    /LOG

   /LOG (D)
   /NOLOG

   Controls whether Digital Test Manager displays informational and
   success messages on your screen.

2.2  –  Example

   DTM> CREATE GROUP SEND_NONINT
   _Remark: Tests of MAIL commands that send text (SEND, REPLY, etc.)
   %DTM-S-CREATED, group SEND_NONINT created
   DTM>

   This example creates the group SEND_NONINT.

3  –  LIBRARY

   Creates a Digital Test Manager library in an empty OpenVMS directory.

   Format

     CREATE LIBRARY  directory-specification [/qualifier] "remark"

3.1  –  Restrictions

   o  Do not create subdirectories of the directory containing the
      Digital Test Manager library. Digital Test Manager recognizes that they
      are not part of the library and may delete them.

   o  Do not create or modify files in the Digital Test Manager library
      and do not delete files from the Digital Test Manager library.

   o  Do not access the Digital Test Manager library with commands other
      than Digital Test Manager commands. Use only Digital Test Manager
      Review subsystem commands to access test run output files.

3.2  –  Command Qualifier

3.2.1    /LOG

   /LOG (D)
   /NOLOG

   Controls whether Digital Test Manager displays informational and
   success messages on your screen.

3.3  –  Example

   $ CREATE/DIR [USER01.DTMLIB]
   $ DTM
   DTM> CREATE LIBRARY [USER01.DTMLIB]
   %DTM-S-CREATED, Digital Test Manager library DUA0:[USER01.DTMLIB] created
   DTM>

   This example shows how to create a Digital Test Manager library
   by first creating an empty directory, DTMLIB.DIR, and then
   using the CREATE LIBRARY command to turn this directory into a
   Digital Test Manager library.

4  –  TEST_DESCRIPTION

   Creates a test description in the Digital Test Manager library.

   Format

     CREATE TEST_DESCRIPTION  test-name [/qualifier...] "remark"

4.1  –  Restrictions

   o  The /COMMAND qualifier applies to DECwindows tests only.

   o  The /FILTER qualifier applies to noninteractive and terminal
      tests only.

4.2  –  Command Qualifiers

4.2.1    /BENCHMARK

   /BENCHMARK=file-specification

   Specifies the file to contain the expected output from the test's
   execution. Digital Test Manager supplies a file name of the form
   test-name.BMK. If your file specification includes a directory
   specification, it overrides the default benchmark directory
   for the library. Benchmark files may be located in the Digital Test
   Manager library, in another directory, or in a CMS library.

4.2.2    /COMMAND

   /COMMAND="DCL-command"

   Specifies a command to be executed before the test is recorded or
   executed. Use this qualifier to start applications for inclusion
   in the test. This qualifier applies to DECwindows tests only.

4.2.3    /COMPARISON_TYPE

   /COMPARISON_TYPE=keyword

   Specifies how the result and benchmark files are to be compared. A
   comparison type is not associated with the test description. The
   valid values for keyword are as follows:

     Keyword     Meaning

     CHARACTERS  Compares files character by character.

     RECORDS     Compares files record by record. This is the
                 default for noninteractive terminal tests.

     SCREENS     Compares files screen by screen; screens not
                 marked are not compared. This is the default for
                 interactive terminal and DECwindows tests.

   DECwindows tests can only use the SCREENS comparison type.
   The SCREENS comparison type is also the default comparison
   type for interactive terminal tests. If you specify the
   /COMPARISON_TYPE=SCREENS qualifier for a noninteractive test,
   this value is ignored.

4.2.4    /DECWINDOWS

   Specifies that the test being created is marked as a DECwindows
   test.

4.2.5    /EPILOGUE

   /EPILOGUE=file-specification

   Adds the specified epilogue file to the test description. The
   test epilogue file is run immediately after the test template file
   is executed. This epilogue file is unrelated to the collection
   epilogue file.

   You cannot store epilogue files in the Digital Test Manager library;
   store them in another directory or in a CMS library.

4.2.6    /FILTER

   /FILTER=(keyword,...)

   Available for interactive and noninteractive terminal tests only,
   the /FILTER qualifier selects one or more filters to remove
   run-time data from the result file that the test run produces.
   The valid values for keyword are as follows:

     Keyword       Filter

     ALL           Specifies that all the filters in this table be used

     DATE          Where the date form is abbreviated, the date filter
                   replaces date stamps by substituting a "d" for each
                   displayed number of the day of the month, an "m" for
                   each displayed letter of the month, and a "y" for
                   each displayed number of the year. Where the date
                   form is spelled out, the month name is replaced by
                   "month", the numeric day is replaced by "day", and
                   the year is replaced by "year".

                   The following list shows some examples of the date
                   filtering functions; this list is not all inclusive.

                     17-OCT-1998 with dd-mmm-yyyy
                     17 OCT 98 with dd mmm yy
                     98.OCT.17 with yy.mmm.dd
                     10/17/98 with mm/dd/yy
                     1998/10/17 with yyyy/mm/dd
                     October 17, 1998 with month day, year
                     Oct. 17, 1998 with month day, year
                     17.October.1998 with day.month.year
                     98-October-17 with year-month-day

     TIME          Replaces time stamps with the following forms:

                     15:37:53.22 with hh:mm:ss.xxxx
                     15:37:53 with hh:mm:ss
                     15:37 with hh:mm
                     3:37 PM with hh:mm xm
                     15H37m with hhHmmm
                     15H37' with hhHmm'
                     15.37 h with hh.mm h
                     15 h 37"53 s with hh h mm"ss s
                     15 h 37 min with hh h mm min
                     kl 15.37 with kl hh.mm
                     h 15.37 with h hh.mm

     FILE_NAMES    Replaces the file names with FILENAME.EXT

     DIRECTORIES   Replaces the directory specification field in
                   the file specification with DISK:[DIRECTORY]

     TRACE_BACK    Replaces 32-bit memory addresses with xxxxxxxx and
                   64-bit memory addresses with xxxxxxxx xxxxxxxx.

     VERSION       Replaces file versions with VERSION

   If you specify more than one keyword, separate the keywords with
   commas and enclose the list in parentheses. If you specify only
   one keyword, omit the parentheses.

4.2.7    /INTERACTIVE

   /INTERACTIVE
   /NOINTERACTIVE (D)

   Specifies whether the test being created is marked as an
   interactive terminal test.

   The /INTERACTIVE qualifier marks a test description as containing
   an interactive terminal test. The /NOINTERACTIVE qualifier marks a
   test description as containing a noninteractive test.

4.2.8    /LOG

   /LOG (D)
   /NOLOG

   Controls whether Digital Test Manager displays informational and
   success messages on your screen.

4.2.9    /PROLOGUE

   /PROLOGUE=file-specification

   Adds the specified prologue file to the test description.

   The test prologue file is run immediately before the test
   template file is executed. This prologue file is unrelated to
   the collection prologue file.

   You cannot store prologue files in the Digital Test Manager library;
   store them in another directory or in a CMS library.

4.2.10    /TEMPLATE

   /TEMPLATE=file-specification

   Specifies the command file that runs a test, the file containing
   an interactive terminal or DECwindows session. Digital Test Manager
   supplies a template file name of the form test-name.COM for
   noninteractive tests and test-name.SESSION for interactive and
   DECwindows tests. If your file specification includes a directory
   specification, Digital Test Manager ignores the default template
   directory.

   You cannot store template files that you create, except SESSION
   files, in the Digital Test Manager library; store them in another
   directory, or in a CMS library.

4.2.11    /VARIABLE

   /VARIABLE=(variable-name[=variable-value],...)

   Enables you to associate existing variables with the test
   description you are creating. The variables you specify must
   be defined in the Digital Test Manager library by using the CREATE
   VARIABLE command. A variable associated with a test description
   by this qualifier is local in scope.

   The /VARIABLE qualifier also enables you to redefine values for
   the variables you specify. If you specify an optional value, the
   variable takes on that value only for this test description; the
   value of the original variable is unaffected.

   If you specify more than one variable name, separate the names
   with commas and enclose the list in parentheses. If you specify
   only one variable name, omit the parentheses. You cannot use
   wildcards.

4.3  –  Examples

   1.  DTM> CREATE TEST_DESCRIPTION SEND_MAIL_TEST
       _Remark: Send a message test.
       %DTM-I-DEFAULTED, benchmark file name defaulted to SEND_MAIL_TEST.BMK
       %DTM-I-DEFAULTED, template file name defaulted to SEND_MAIL_TEST.COM
       %DTM-S-CREATED, test description SEND_MAIL_TEST created.
       DTM>

   This example creates a noninteractive test description with the
   test name SEND_MAIL_TEST.

   2.  DTM> CREATE TEST_DESCRIPTION/TEMPLATE=MAIL_INT.COM -
       _DTM> /INTERACTIVE/PROLOGUE=NOBROADCAST.COM/EPILOGUE=BROADCAST.COM
       _test name: MAIL_TEST_INT
       _Remark: Creating a MAIL test
       %DTM-I-DEFAULTED, benchmark file name defaulted to MAIL_TEST_INT.BMK
       %DTM-I-DEFAULTED, template file name defaulted to MAIL_TEST_INT.SESSION
       %DTM-S-CREATED, test description MAIL_TEST_INT created
       DTM>

   This example creates an interactive test description
   MAIL_TEST_INT and includes template, prologue, and epilogue
   file names. Note that Digital Test Manager prompts for the test
   name and remark.

5  –  VARIABLE

   Defines a variable in the Digital Test Manager library.

   Format

     CREATE VARIABLE  variable-name variable-value [/qualifier...]

          "remark"

5.1  –  Command Qualifiers

5.1.1    /GLOBAL

   Defines the variable as being accessible to all tests in all
   collections. You cannot specify both /LOCAL and /GLOBAL with the
   same CREATE VARIABLE command. The default is /LOCAL.

5.1.2    /LOCAL

   Defines the variable as being accessible only to an individual
   test that references it in its test description. The default is
   /LOCAL. You cannot specify both /LOCAL and /GLOBAL with the same
   CREATE VARIABLE command.

5.1.3    /LOG

   /LOG (D)
   /NOLOG

   Controls whether Digital Test Manager displays informational and
   success messages on your screen.

5.1.4    /LOGICAL

   Defines the variable as a OpenVMS logical name. You cannot specify
   both /LOGICAL and /SYMBOL with the same CREATE VARIABLE command.
   The default is /SYMBOL.

5.1.5    /NUMERIC

   Used only with the /SYMBOL qualifier, the /NUMERIC qualifier
   defines the symbol type as a numeric value. Use this qualifier
   to define a quoted symbol value as numeric. You cannot specify
   both /NUMERIC and /STRING with the same CREATE VARIABLE command.
   If the variable value is not enclosed in quotation marks (" "),
   the variable type is defined as a numeric value.

5.1.6    /STRING

   Used with the /SYMBOL qualifier, the /STRING qualifier defines
   a symbol type as a text string. Use this qualifier to define an
   unquoted symbol value as a text string. You cannot specify both
   /NUMERIC and /STRING with the same CREATE VARIABLE command. If the
   variable value is enclosed in quotation marks (" "),  the variable
   type is defined as a text string.

5.1.7    /SYMBOL

   Defines the variable to be a OpenVMS symbol. When you specify a
   variable as a symbol with the /SYMBOL qualifier, you must further
   define it as either a numeric value (with the /NUMERIC qualifier)
   or a text string (with the /STRING qualifier). You cannot specify
   both /LOGICAL and /SYMBOL with the same CREATE VARIABLE command.
   The default is /SYMBOL.

5.2  –  Example

   DTM> CREATE VARIABLE/SYMBOL/LOCAL INPUT_FILE "emptyfil"
   _Remark: Name of input file, with an empty file as the default
   %DTM-S-CREATED, symbol variable INPUT_FILE created.
   DTM>

   This example creates the variable INPUT_FILE. It is defined as
   a local symbol, with a default value of emptyfil. The quotation
   marks indicate that the value is a string.
Close Help