RobotJ DDDriverCounterCommands::DeleteCounter
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
-
counterID
The unique name used to identify this private counter.
These unique names are case-insensitive.
- [ Description = ]
Any additional information for deleting this counter.
Examples:
[How To Read This Reference]
RobotJ DDDriverCounterCommands::LogCounterInfo
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
-
counterID
The unique name used to identify this private counter.
These unique names are case-insensitive.
- [ 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]
RobotJ DDDriverCounterCommands::ResetCounter
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
-
counterID
The unique name used to identify this private counter.
These unique names are case-insensitive.
- [ Description = ]
Any additional information for resetting this counter.
Examples:
-
C, ResetCounter, "TestCase 124", "Zero all counts to retest"
Create and/or reset counts on a counter called "TestCase 124".
If the counter does not exist, create it and enable counting
all status information.
If the counter already exists, reset counts to zero(0).
[How To Read This Reference]
RobotJ DDDriverCounterCommands::ResumeStatusCounts
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
- [ Description = ]
Any additional information for resuming status counts.
- [ 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]
RobotJ DDDriverCounterCommands::SetCounterMode
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
-
counterID
The unique name used to identify this private counter.
These unique names are case-insensitive.
-
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:
-
C, SetCounterMode, "TestCase 124", "StepTestsOnly"
Create a new counter with the mode or modify the mode of an
existing counter.
The "TestCase 124" counter will be created and/or modified to
use the "StepTestsOnly" counting mode.
-
C, SetCounterMode, "TestCase 124", "2"
Create a new counter with the mode or modify the mode of an
existing counter.
The "TestCase 124" counter will be created and/or modified to
use the "StepTestsOnly" counting mode.
[How To Read This Reference]
RobotJ DDDriverCounterCommands::StartCounter
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
-
counterID
The unique name used to identify this private counter.
These unique names are case-insensitive.
- [ Description = ]
Any additional information such as the purpose of the counter.
Examples:
-
C, StartCounter, "TestCase 124", "Verify we can login."
Create and/or (re)start a counter called "TestCase 124".
If the counter does not exist, create it and begin counting
all status information. If the counter already exists,
enable the counter to resume counting. This latter assumes
the counter was previously stopped.
[How To Read This Reference]
RobotJ DDDriverCounterCommands::StartCycle
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
-
CycleID
The user-defined ID of the item.
- [ Description = ]
A description of the item.
Examples:
-
C StartCycle Option1
Logs the start of testing on an item with an ID of Option1.
The private status counter is also started.
-
C StartCycle Option1 "Integration Testing"
Logs the start of testing on an item with an ID of Option1.
The private status counter is also started.
[How To Read This Reference]
RobotJ DDDriverCounterCommands::StartProcedure
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
-
ProcedureID
The user-defined ID of the item.
- [ Description = ]
A description of the item.
Examples:
-
C StartProcedure Option1
Logs the start of testing on an item with an ID of Option1.
The private status counter is also started.
-
C StartProcedure Option1 "Entering New Users"
Logs the start of testing on an item with an ID of Option1.
The private status counter is also started.
[How To Read This Reference]
RobotJ DDDriverCounterCommands::StartRequirement
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
-
RequirementID
The user-defined ID of the item.
- [ Description = ]
A description of the item.
Examples:
-
C StartRequirement Option1
Logs the start of testing on an item with an ID of Option1.
The private status counter is also started.
-
C StartRequirement Option1 "It Must Compile"
Logs the start of testing on an item with an ID of Option1.
The private status counter is also started.
[How To Read This Reference]
RobotJ DDDriverCounterCommands::StartSuite
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
-
SuiteID
The user-defined ID of the item.
- [ Description = ]
A description of the item.
Examples:
-
C StartSuite Option1
Logs the start of testing on an item with an ID of Option1.
The private status counter is also started.
-
C StartSuite Option1 "Data Testing"
Logs the start of testing on an item with an ID of Option1.
The private status counter is also started.
[How To Read This Reference]
RobotJ DDDriverCounterCommands::StartTestcase
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
-
TestCaseID
The user-defined ID of the Testcase.
- [ Description = ]
A description of the Testcase
Examples:
-
C StartTestcase Option1
Logs the start of a testcase with an ID of Option1.
The private status counter is also started.
-
C StartTestcase Option1 "It Must Compile"
Logs the start of a testcase with an ID of Option1.
The private status counter is also started.
[How To Read This Reference]
RobotJ DDDriverCounterCommands::StopCounter
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
-
counterID
The unique name used to identify this private counter.
These unique names are case-insensitive.
- [ Description = ]
Any additional information for stopping this counter.
Examples:
-
C, StopCounter, "TestCase 124", "Done testing Login"
Create and/or suspend counts on a counter called "TestCase 124".
If the counter does not exist, create it and enable counting
all status information but suspend all counting.
If the counter already exists, suspend counting within it.
[How To Read This Reference]
RobotJ DDDriverCounterCommands::StopCycle
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
-
CycleID
The user-defined ID of the item.
- [ Description = ]
A description of the item.
Examples:
-
C StopCycle Option1
Logs the end of testing on an item with an ID of Option1.
The private status counter is also stopped.
-
C StopCycle Option1 "Integration Testing"
Logs the end of testing on an item with an ID of Option1.
The private status counter is also stopped.
[How To Read This Reference]
RobotJ DDDriverCounterCommands::StopProcedure
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
-
ProcedureID
The user-defined ID of the item.
- [ Description = ]
A description of the item.
Examples:
-
C StopProcedure Option1
Logs the end of testing on an item with an ID of Option1.
The private status counter is also stopped.
-
C StopProcedure Option1 "Entering New Users"
Logs the end of testing on an item with an ID of Option1.
The private status counter is also stopped.
[How To Read This Reference]
RobotJ DDDriverCounterCommands::StopRequirement
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
-
RequirementID
The user-defined ID of the item.
- [ Description = ]
A description of the item.
Examples:
-
C StopRequirement Option1
Logs the end of testing on an item with an ID of Option1.
The private status counter is also stopped.
-
C StopRequirement Option1 "It Must Compile"
Logs the end of testing on an item with an ID of Option1.
The private status counter is also stopped.
[How To Read This Reference]
RobotJ DDDriverCounterCommands::StopSuite
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
-
SuiteID
The user-defined ID of the item.
- [ Description = ]
A description of the item.
Examples:
-
C StopSuite Option1
Logs the end of testing on an item with an ID of Option1.
The private status counter is also stopped.
-
C StopSuite Option1 "Data Tests"
Logs the end of testing on an item with an ID of Option1.
The private status counter is also stopped.
[How To Read This Reference]
RobotJ DDDriverCounterCommands::StopTestcase
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
-
TestCaseID
The user-defined ID of the Testcase.
- [ Description = ]
A description of the Testcase
Examples:
-
C StopTestcase Option1
Logs the end of a testcase with an ID of Option1.
The private status counter is also stopped.
-
C StopTestcase Option1 "It Must Compile"
Logs the end of a testcase with an ID of Option1.
The private status counter is also stopped.
[How To Read This Reference]
RobotJ DDDriverCounterCommands::StoreCounterInfo
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
-
counterID
The unique name used to identify the private counter.
These unique names are case-insensitive.
-
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]
RobotJ DDDriverCounterCommands::SuspendStatusCounts
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
- [ Description = ]
Any additional information for suspending status counts.
- [ 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]