19.1

General parameters of the check functions

The methods provided for testing accessibility can be set using various parameters, for example to define the scope of the test or the type of logging.
These parameters are explained in more detail below.

scope

The QF-Test ID of the Component within which the checks are to be applied is specified here. The tests are only applied to this component and its child components.
Default: genericDocument, the entire page

genericClassesToSkip

The comma-separated names of Generic classes which are to be skipped in the tests. These classes and any subclasses are not checked during the tests.
Default: -

showSuccessfulChecks

If this parameter is set to true, successful checks are also listed as information in the log.
Default: false

skipInvisibleElements

If true, the checks will not be performed for invisible elements.
Default: true

showSkippedChecks

If this parameter is set to true, checks that could not be fully executed are listed as a warning in the log. One reason for this may be, for example, that the element to be tested is covered by another element.
Default: true

logOverviewScreenshot

Determines whether a screenshot should be generated in the event of an error to provide an overview of the faulty elements. The overview screenshot includes the defined scope, so it can also include the entire page. On the screenshot, elements with errors are outlined in red, elements with warnings in yellow.
Default: true

allowedHeightOfOverviewScreenshot

Defines the maximum height (in pixels) for the overview screenshot. Only applies if the screenshot would be larger than the browser view. The limit is required for memory reasons.
Default: 2000

logElementScreenshots

Determines whether an image of the individual elements should be created in the event of an error.
If the value is all, an image is created for every single element.
If the value is first, an image is created only for the first element of each error type.
If the value is none, no image is created.
On the screenshot, elements with errors are outlined in red, elements with warnings in yellow. The total amount of element screenshot in the run log is limited by the following parameter allowedNumberOfElementScreenshots.
Default: all
Possible Values: all, first, none

allowedNumberOfElementScreenshots

Determines the maximum number of images of individual elements in the event of an error. The limit is required for memory reasons.
Default: 10

logElementSmartIdToMessage

Determines whether the QF-Test specific SmartID of the checked element should be listed in the log.
The SmartID helps addressing components within QF-Test.
Default: false

squashCheckResultsWithSameMessage

If this parameter is set to true, elements with the same error message are grouped together in the log under a single error (or warning).
Default: false