Globale Konfiguration

Überblick über die globale Konfiguration

Das Global-Panel von Axe-Konfiguration bietet eine zentrale Möglichkeit, die Einstellungen für Barrierefreiheitstests in Ihrem Unternehmen zu verwalten und zu steuern. Diese leistungsstarke Funktion ermöglicht es Unternehmensadministratoren, konsistente Teststandards festzulegen und gleichzeitig den einzelnen Teams und Entwicklern die Flexibilität zu geben, die sie benötigen, um effektiv zu arbeiten.

Was ist die globale Konfiguration?

Die globale Konfiguration (der Global-Tab von Axe Configuration) ist eine Reihe von Steuerungen, die festlegen, wie Axe Watcher während der Barrierefreiheitstests funktioniert. Diese Einstellungen umfassen:

• Gegen welche Barrierefreiheitsstandards geprüft werden soll (wie z. B. WCAG 2.1 AA oder EN 301 549)
• Ob beste Praktiken-Prüfungen einbezogen werden sollen
• Ob experimentelle Regeln aktiviert werden sollen
• Welche Version von axe-core für Tests verwendet werden soll

Diese Einstellungen können sowohl auf Unternehmensebene als auch auf Ebene der einzelnen Benutzer verwaltet werden und schaffen so eine flexible, aber kontrollierte Testumgebung.

Warum globale Konfiguration verwenden?

Die globale Konfiguration löst mehrere häufige Herausforderungen im Unternehmens-Barrierefreiheitstesting:

• Konsistenz: Sicherstellen, dass alle Teams nach den gleichen Barrierefreiheitsstandards testen
• Einhaltung: Durchsetzung spezifischer Testanforderungen innerhalb Ihrer Organisation
• Flexibilität: Teams ermöglichen, ihren Testansatz innerhalb genehmigter Parameter zu individualisieren
• Versionskontrolle: Verwalten, welche axe-core-Versionen in Projekten verwendet werden können
• Qualitätssicherung: Aufrechterhaltung von Teststandards bei gleichzeitiger Ermöglichung team-spezifischer Optimierungen

Wie funktioniert die globale Konfiguration?

Administratoren

Administratoren legen unternehmensweite Standards fest und bestimmen, welche Einstellungen Benutzer über die configurationOverrides-Eigenschaft (JavaScript/TypeScript) oder AxeWatcherOptions.setConfgurationOverrides()-Methode (Java) ändern können. Diese Einstellungen legen die Basis für Axe Watcher Tests innerhalb der Organisation fest. Diese Einstellungen werden im Global-Panel von Axe-Konfiguration geändert.

Benutzer

Einzelne Benutzer passen Axe Watcher an, indem sie die configurationOverrides-Option in ihrem Testsetup-Code ändern oder hinzufügen, um Werte zu wählen, die sich von denen unterscheiden, die ihr Unternehmensadministrator festgelegt hat (aber nur für Einstellungen, bei denen der Administrator das Benutzern erlauben zu ändern-Kontrollkästchen aktiviert hat).

Die configurationOverrides-Option interagiert mit den Einstellungen im Global-Panel, wie in der Tabelle in Gemeinsame globale Konfiguration und Konfigurationsüberschreibungsszenarien definiert.

Die API-Referenzen enthalten weitere Informationen über (JavaScript/TypeScript) configurationOverrides oder (Java) ConfigurationsOverrides und dessen Eigenschaften.

Häufige globale Konfigurationen und Konfigurationsüberschreibungs-Szenarien

Wenn ein Test läuft, fusioniert das Axe Developer Hub Unternehmens- und Benutzereinstellungen, um die endgültige Testkonfiguration zu erstellen. Dies stellt sicher, dass alle Anpassungen innerhalb der genehmigten Parameter bleiben, während den Benutzern die notwendige Flexibilität gewährt wird.

Die folgende Tabelle veranschaulicht häufige Szenarien, die Sie bei der Arbeit mit globalen Konfigurationen antreffen werden. Jedes Szenario zeigt, wie Unternehmenseinstellungen mit Ihrer Projektkonfiguration interagieren.

Verstehen der Ergebnisse

• ✅ Erfolg: Konfiguration funktioniert wie erwartet
• ⚠️ Warnung: Konfiguration funktioniert, wird aber nicht empfohlen
• ❌ Fehler: Konfiguration wird fehlschlagen

Empfehlungen

1. Bevorzuge immer configurationOverrides über runOptions.
2. Überprüfen Sie Ihre Unternehmenseinstellungen, bevor Sie Überschreibungen konfigurieren.
3. Überschreiben Sie Einstellungen nur bei Bedarf.
4. Verwenden Sie die einfachste Konfiguration, die Ihre Anforderungen erfüllt.

Beispielkonfiguration für Überschreibungen

Hier ist eine Beispielkonfiguration, die Überschreibungen zeigt, um WCAG 2.1 AA zu folgen, axe-core auf Version 4.9.1 zu setzen und experimentelle Regeln sowie beste Praktiken zuzulassen:

const config = {
  axe: {
    apiKey: 'YOUR_API_KEY',
    projectId: 'YOUR_PROJECT_ID',

    configurationOverrides: {
      accessibilityStandard: 'WCAG 2.1 AA',
      axeCoreVersion: '4.9.1',
      experimentalRules: true,
      bestPractices: true
    }
};

Siehe (JavaScript/TypeScript) ConfigurationOverrides Schnittstelle oder (Java) ConfigurationOverrides Klasse für eine Erklärung der Eigenschaften.

Fehler und Warnungen

Fehler

Nicht zugelassener Standard

Wenn Sie versuchen, einen nicht zugelassenen Standard zu verwenden, erhalten Sie den Server-Antwortcode 422, Unprocessable Content. Beispielnachricht:

Error: Server responded to https://axe.deque.com/api-pub/watcher/sessions with status code 422: "error": "Invalid accessibility standard: WCAG 2.0 AA. Allowed options: EN 301 549, Trusted Tester v5"

Verwendung von runOptions.runOnly mit configurationOverrides

Wenn Sie sowohl runOptions.runOnly mit configurationOverrides verwenden, schlagen Ihre Tests sofort fehl.

Warnungen

Verwendung von runOptions mit runOnly oder rules

Wenn Sie die Eigenschaften runOnly oder rules am Objekt runOptions festlegen, erhalten Sie diese Nachricht:

This scan was created using runOptions. This may not be aligned with your organization's global configurations.

Die Verwendung entweder von runOnly oder rules könnte es Ihrem Code ermöglichen, Zugänglichkeitsregeln zu verwenden, die nicht durch die globale Konfiguration Ihrer Organisation erlaubt sind.

@axe-core/watcher ohne Unterstützung für globale Konfiguration

Wenn Sie eine Version von @axe-core/watcher verwenden, die zu alt ist, um Unterstützung für globale Konfigurationen zu bieten, erhalten Sie diese Nachricht:

Siehe auch

• Axe-Konfiguration
• (JavaScript/TypeScript) configurationOverrides Referenz
• (Java) ConfigurationOverrides Klasse