DDDriverCounterCommands

Last Updated:

Driver Commands for the Cycle, Suite, and Step drivers

This keyword library provides Driver Commands that can be used by all three DDE Drivers--CycleDriver, SuiteDriver, and StepDriver. That means they can be used in any keyword driven test tables regardless of the test tables level--Cycle, Suite, or Step.

Each different driver command has different parameters as described in its documentation. For reference, the first fields of ALL Driver Command test records are defined below:

Field #1
The "C" = DRIVER COMMAND record type specifier.
Field #2
The Driver Command keyword.

Example:

c , SetApplicationMap , "AppMap.map"

Driver Command parameters must be placed in the test record in the field position specified in the documentation. Some parameters are optional. However, the field associated with that parameter must be honored. If you wish to skip an optional parameter you must still provide an empty field for that parameter.

Example:

c, LaunchApplication, NOTEPAD, NOTEPAD.EXE, , , "AppMap.map"

The above example shows two optional fields after NOTEPAD.EXE which are given no value(skipped).

Note that the full availablility of all Driver Commands is now spread across several files. Together, all of these files provide all the Driver Commands available to the core framework.

DDDriverCommands
Miscellaneous and often used Commands.
DDDriverLogCommands
Commands focused on logging test execution.
DDDriverFlowCommands
Commands focused on Error Recovery and Flow Control.
DDDriverCounterCommands
Commands focused on status tracking.
DDDriverDeprecatedCommands
Commands that are still provided for backward compatibility, but are no longer supported.
DDDriverDebugCommands
Commands focused on debugging test execution.


[How To Read This Reference]
DeleteCounter
RC TID WR
Delete any existing private counter with the provided counterID.
LogCounterInfo
RC TID WR SE2
Log the specified counter's info in the active log(s) of the current Log Facility.
ResetCounter
RC TID WR
Create a new private counter or reset counts in an existing private counter.
ResumeStatusCounts
RC TID WR SE2
Resume counting on ALL status counters--both public/global and private.
SetCounterMode
RC TID WR
Create a new private counter or modify the mode of an existing private counter.
StartCounter
RC TID WR SE2
Create a new private counter or start an existing stopped private counter.
StartCycle
RC TID WR
Begin tracking status on a user-defined item.
StartProcedure
RC TID WR
Begin tracking status on a user-defined item.
StartRequirement
RC TID WR
Begin tracking status on a user-defined item.
StartSuite
RC TID WR SE2
Begin tracking status on a user-defined item.
StartTestcase
RC TID WR SE2
Begin tracking status on a user-defined TestCase.
StopCounter
RC TID WR SE2
Create a new private counter or suspend counts in an existing private counter.
StopCycle
RC TID WR
Stop tracking status on a user-defined item.
StopProcedure
RC TID WR
Stop tracking status on a user-defined item.
StopRequirement
RC TID WR
Stop tracking status on a user-defined item.
StopSuite
RC TID WR
Stop tracking status on a user-defined item.
StopTestcase
RC TID WR SE2
Stop tracking status on a user-defined TestCase.
StoreCounterInfo
RC TID WR SE2
Store the current values of the named counter into unique DDVariables.
SuspendStatusCounts
RC TID WR SE2
Suspend counting on ALL status counters--both public/global and private.

DDDriverCounterCommands::DeleteCounter
RC TID WR

Delete any existing private counter with the provided counterID.

If counterID identifies an existing counter, then delete it.

See ApplicationUtilities for more information on private counters.



Fields: [ ]=Optional with Default Value
  1. counterID
    The unique name used to identify this private counter.

    These unique names are case-insensitive.

  2. [ Description = ]
    Any additional information for deleting this counter.


Examples:
[How To Read This Reference]

DDDriverCounterCommands::LogCounterInfo
RC TID WR SE2

Log the specified counter's info in the active log(s) of the current Log Facility.

Extracts a snapshot of the specified private counter and outputs a small, embedded Status Report in the active logs of the current Log Facility. The Status Report will be identified by the name of the private counter. (Future) We will allow you to optionally specify a different Log Facility by name.

Fields: [ ]=Optional with Default Value
  1. counterID
    The unique name used to identify this private counter.

    These unique names are case-insensitive.

  2. [ logName = MainLog ]
    (Future) The name of a Log Facility other than the "current" one.

    When suppport for named Log Facilities is provided you will be able to specify which of these you wish to receive the Status Report.

Examples:
[How To Read This Reference]

DDDriverCounterCommands::ResetCounter
RC TID WR

Create a new private counter or reset counts in an existing private counter.

If counterID is not already an active private counter, then this routine will create a new private counter with the provided counterID as its name. The counter will be enabled for counting of all status information at all test levels.

If counterID identifies an existing counter, then this routine will reset all its counts to zero(0).

See ApplicationUtilities for more information on private counters.



Fields: [ ]=Optional with Default Value
  1. counterID
    The unique name used to identify this private counter.

    These unique names are case-insensitive.

  2. [ Description = ]
    Any additional information for resetting this counter.


Examples:
[How To Read This Reference]

DDDriverCounterCommands::ResumeStatusCounts
RC TID WR SE2

Resume counting on ALL status counters--both public/global and private.

Resume all status counting that is triggered via ApplicationUtilities. Only counters that are enabled--not independently "stopped"--will resume counting. Stopped counters are still stopped.

See ApplicationUtilities for more information on counters.



Fields: [ ]=Optional with Default Value
  1. [ Description = ]
    Any additional information for resuming status counts.


  2. [ logName = MainLog ]
    (Future) The name of a Log Facility other than the "current" one.

    When suppport for named Log Facilities is provided you will be able to specify which of these you wish to receive the notice.

Examples:
[How To Read This Reference]

DDDriverCounterCommands::SetCounterMode
RC TID WR

Create a new private counter or modify the mode of an existing private counter.

If counterID is not already an active private counter, then this routine will create a new private counter with the provided counterID and counting mode.

If counterID identifies an existing counter, then this routine will modify the counting mode of the existing counter.

See AUSetStatusCounterMode for more information on private counters.



Fields: [ ]=Optional with Default Value
  1. counterID
    The unique name used to identify this private counter.

    These unique names are case-insensitive.

  2. mode
    The counting mode to use for the specified counter.

    Currently supported modes are:
    • "AllStatusInfo" or "1"
    • "StepTestsOnly" or "2"
    Consult AUSetStatusCounterMode for more information on private counters.

Examples:
[How To Read This Reference]

DDDriverCounterCommands::StartCounter
RC TID WR SE2

Create a new private counter or start an existing stopped private counter.

If counterID is not already an active private counter, then this routine will create a new private counter with the provided counterID as its name. The counter will be enabled for counting of all status information at all test levels.

If counterID identifies an existing counter, then this routine will enable the counter to resume counting--assuming it was stopped.

See ApplicationUtilities for more information on private counters.



Fields: [ ]=Optional with Default Value
  1. counterID
    The unique name used to identify this private counter.

    These unique names are case-insensitive.

  2. [ Description = ]
    Any additional information such as the purpose of the counter.


Examples:
[How To Read This Reference]

DDDriverCounterCommands::StartCycle
RC TID WR

Begin tracking status on a user-defined item.

Log/process the beginning of testing associated with this user-defined item. A private counter will keep track of status for the item.

Fields: [ ]=Optional with Default Value
  1. CycleID
    The user-defined ID of the item.


  2. [ Description = ]
    A description of the item.


Examples:
[How To Read This Reference]

DDDriverCounterCommands::StartProcedure
RC TID WR

Begin tracking status on a user-defined item.

Log/process the beginning of testing associated with this user-defined item. A private counter will keep track of status for the item.

Fields: [ ]=Optional with Default Value
  1. ProcedureID
    The user-defined ID of the item.


  2. [ Description = ]
    A description of the item.


Examples:
[How To Read This Reference]

DDDriverCounterCommands::StartRequirement
RC TID WR

Begin tracking status on a user-defined item.

Log/process the beginning of testing associated with this user-defined item. A private counter will keep track of status for the item.

Fields: [ ]=Optional with Default Value
  1. RequirementID
    The user-defined ID of the item.


  2. [ Description = ]
    A description of the item.


Examples:
[How To Read This Reference]

DDDriverCounterCommands::StartSuite
RC TID WR SE2

Begin tracking status on a user-defined item.

Log/process the beginning of testing associated with this user-defined item. A private counter will keep track of status for the item.

Fields: [ ]=Optional with Default Value
  1. SuiteID
    The user-defined ID of the item.


  2. [ Description = ]
    A description of the item.


Examples:
[How To Read This Reference]

DDDriverCounterCommands::StartTestcase
RC TID WR SE2

Begin tracking status on a user-defined TestCase.

Log/process the beginning of testing associated with a user-defined Testcase. A private counter will keep track of status for the testcase.

Fields: [ ]=Optional with Default Value
  1. TestCaseID
    The user-defined ID of the Testcase.


  2. [ Description = ]
    A description of the Testcase


Examples:
[How To Read This Reference]

DDDriverCounterCommands::StopCounter
RC TID WR SE2

Create a new private counter or suspend counts in an existing private counter.

If counterID is not already an active private counter, then this routine will create a new private counter with the provided counterID as its name. The counter will be enabled for counting of all status information at all test levels but will be suspended from actually counting.

If counterID identifies an existing counter, then this routine will suspend counting within this counter.

See ApplicationUtilities for more information on private counters.



Fields: [ ]=Optional with Default Value
  1. counterID
    The unique name used to identify this private counter.

    These unique names are case-insensitive.

  2. [ Description = ]
    Any additional information for stopping this counter.


Examples:
[How To Read This Reference]

DDDriverCounterCommands::StopCycle
RC TID WR

Stop tracking status on a user-defined item.

Log/process the end of testing associated with a user-defined item. A private counter will keep track of status for the item.

Fields: [ ]=Optional with Default Value
  1. CycleID
    The user-defined ID of the item.


  2. [ Description = ]
    A description of the item.


Examples:
[How To Read This Reference]

DDDriverCounterCommands::StopProcedure
RC TID WR

Stop tracking status on a user-defined item.

Log/process the end of testing associated with a user-defined item. A private counter will keep track of status for the item.

Fields: [ ]=Optional with Default Value
  1. ProcedureID
    The user-defined ID of the item.


  2. [ Description = ]
    A description of the item.


Examples:
[How To Read This Reference]

DDDriverCounterCommands::StopRequirement
RC TID WR

Stop tracking status on a user-defined item.

Log/process the end of testing associated with a user-defined item. A private counter will keep track of status for the item.

Fields: [ ]=Optional with Default Value
  1. RequirementID
    The user-defined ID of the item.


  2. [ Description = ]
    A description of the item.


Examples:
[How To Read This Reference]

DDDriverCounterCommands::StopSuite
RC TID WR

Stop tracking status on a user-defined item.

Log/process the end of testing associated with a user-defined item. A private counter will keep track of status for the item.

Fields: [ ]=Optional with Default Value
  1. SuiteID
    The user-defined ID of the item.


  2. [ Description = ]
    A description of the item.


Examples:
[How To Read This Reference]

DDDriverCounterCommands::StopTestcase
RC TID WR SE2

Stop tracking status on a user-defined TestCase.

Log/process the end of testing associated with a user-defined Testcase. A private counter will keep track of status for the testcase.

Fields: [ ]=Optional with Default Value
  1. TestCaseID
    The user-defined ID of the Testcase.


  2. [ Description = ]
    A description of the Testcase


Examples:
[How To Read This Reference]

DDDriverCounterCommands::StoreCounterInfo
RC TID WR SE2

Store the current values of the named counter into unique DDVariables.

This enables the framework, scripts, and other applications to retrieve the values of these counters at runtime.

Consult ApplicationUtilities and Using DDVariables for more information on referencing these DDVariables in your tests.

You must adhere to DDVariable naming conventions when providing this DDVariable basename. Note that no spaces are allowed in DDVariable names.

Fields: [ ]=Optional with Default Value
  1. counterID
    The unique name used to identify the private counter.

    These unique names are case-insensitive.

  2. varPrefix
    The unique DDVariable prefix to use for storing counter values.

    The DDVariable prefix will be used to create several DDVariables that will hold the counter information.
      The variables stored:
    • VARPREFIX.successes
    • VARPREFIX.warnings
    • VARPREFIX.general_failures
    • VARPREFIX.test_passes
    • VARPREFIX.test_warnings
    • VARPREFIX.test_failures
    • VARPREFIX.test_records
    • VARPREFIX.total_records
    • VARPREFIX.IO_failures
    • VARPREFIX.skipped_records
    • VARPREFIX.filename
    • VARPREFIX.id
    • VARPREFIX.mode
    • VARPREFIX.suspended

    Consult ApplicationUtilities and Using DDVariables for more information on referencing these DDVariables in your tests.

    You must adhere to DDVariable naming conventions when providing this DDVariable basename. Note that no spaces are allowed in DDVariable names.

Examples:
[How To Read This Reference]

DDDriverCounterCommands::SuspendStatusCounts
RC TID WR SE2

Suspend counting on ALL status counters--both public/global and private.

Suspends all status counting that is triggered via ApplicationUtilities.

See ApplicationUtilities for more information on counters.



Fields: [ ]=Optional with Default Value
  1. [ Description = ]
    Any additional information for suspending status counts.


  2. [ logName = MainLog ]
    (Future) The name of a Log Facility other than the "current" one.

    When suppport for named Log Facilities is provided you will be able to specify which of these you wish to receive the notice.

Examples:
[How To Read This Reference]