Skip to main content

Scan Configurations via Capabilities (Automation)

In automation there is no scan-configuration panel. The scan scope is supplied through each test's capabilities, so every test carries its own configuration and the effective rule set is derived from these values. This is the automation counterpart to the manual Scan Configurations panel.

note

Per-rule enable/disable picking is a Manual-only feature and is not used in automation. In automation, the rule set is computed from the WCAG version plus the group toggles.

When to use this

Use these capabilities when users already run Appium against TestMu AI real devices and want each accessibility scan scoped to a specific WCAG target and set of rule groups—without opening a UI. See Native App Automation Appium (Overview) for the surrounding test setup and the lambda-accessibility-scan hook.

Prerequisites

  • An Appium test project targeting TestMu AI real devices (Android or iOS).
  • LT_USERNAME / LT_ACCESS_KEY available to the process.
  • Accessibility enabled on the session via the accessibility master capability.

Capabilities reference

CapabilityTypeAllowed valuesDefault (RD App Automation)
accessibilitybooleantrue / false— (master toggle; must be true to enable a11y scanning)
accessibility.wcagVersionstringwcag2a, wcag2aa, wcag2aaa, wcag21a, wcag21aa, wcag21aaa, wcag22a, wcag22aa, wcag22aaawcag21aa
accessibility.bestPracticebooleantrue / falsetrue
accessibility.betaRulesbooleantrue / falsetrue
accessibility.aiEnabledbooleantrue / falsefalse

Notes:

  • Defaults apply only when accessibility is true and the specific capability is omitted.
  • accessibility.aiEnabled is the same AI toggle used elsewhere in accessibility; it is reused here.
  • A backend capability accessibility.needsReview also exists but is not part of the standard automation scan config (defaults off).

How the effective rule set is computed

The rule set for a test is derived from the WCAG version and the group toggles, using the same logic as the manual panel:

  • WCAG inheritance. A higher version or level includes the lower ones. Selecting wcag21aa runs every rule whose success criterion is in WCAG 2.0 or 2.1 at level A or AA. WCAG 2.2 rules and AAA-only rules are not included until the version or level is raised.
  • Group combination. Some rules carry a Best Practice, Beta, or AI tag. A rule runs only if both its WCAG criterion is in range and every tag it carries is switched on. For example, a Best Practice rule is skipped when accessibility.bestPractice is false, even if its WCAG criterion is in range.

Example: setting capabilities

Enable accessibility, target WCAG 2.1 AA, keep Best Practice and Beta rules on, and leave AI rules off.

{
"accessibility": true,
"accessibility.wcagVersion": "wcag21aa",
"accessibility.bestPractice": true,
"accessibility.betaRules": true,
"accessibility.aiEnabled": false
}

With these capabilities in place, the scan is triggered at each stable screen:

driver.executeScript("lambda-accessibility-scan");

Only the rules in the effective set are evaluated, and the report for that build contains results for exactly those rules.

What to expect in results

  • Scoped results. Each scan reports violations only for the rules in the test's effective set. Rules outside the WCAG range or behind an off group toggle do not appear and do not affect the accessibility score for that scan.
  • Configuration recorded with the test. The WCAG version and group toggles are stored alongside the scan, so the team can always see how a given result was produced.
  • Applied rules are visible in the report. The report header shows the applied configuration as tags (for example, WCAG 2.1 AA, Best Practices, Beta Rules), and the Applied Settings panel lists every rule that was evaluated—grouped by category and searchable—so the exact selected rules can be confirmed for any scan.

The report shows the applied WCAG target and group tags, and the Applied Settings panel lists the selected rules by category:

Product boundary

This page covers configuring scans through capabilities in automation. For hand-picking individual rules and reusing last-used settings in the manual App Scanner flow, see Scan Configurations (Manual).

Test across 3000+ combinations of browsers, real devices & OS.

Book Demo

Help and Support

Related Articles