Steuerung des Nutzungsdienstes über Umgebungsvariablen

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard

Informationen zur Verwendung von Umgebungsvariablen zur Steuerung des Nutzungsdienstes oder zur Änderung des Ereignisses, das an den Nutzungsdienst gemeldet wird

Not for use with personal data

Dieser Artikel enthält Informationen darüber, wie der Nutzungsdienst über Umgebungsvariablen gesteuert werden kann. Sie können:

  • Steuern, wie der Nutzungsdienst arbeitet.
  • Das Ereignis ändern, das an den Nutzungsdienst gesendet wird.

Steuerung des Nutzungsdienstes über Umgebungsvariablen

Vier Umgebungsvariablen ermöglichen es Ihnen, den Nutzungsdienst zu steuern. Sie können die Sammlung von Nutzungsmetriken deaktivieren, die URL ändern, an die die Ergebnisse gemeldet werden, die eindeutige ID des Benutzers ändern und die vollständigen axe-core-Ergebnisse in jedes Ereignis einfügen.

important

Der Nutzungsbericht ist standardmäßig aktiviert in der CLI und den Axe DevTools-APIs. Um zu verhindern, dass Nutzungsevents gesendet werden, setzen Sie AXE_TRACK_USAGE auf false oder rufen Sie die enableTracking-Methode Ihrer API mit false auf.

note

Wenn Ihr Client den Usage Service nicht erreichen kann, wird er es erneut versuchen, indem er https durch http in der URL ersetzt (festgelegt über die AXE_METRICS_URL Umgebungsvariable).

Änderung des gemeldeten Ereignisses mittels Umgebungsvariablen

Mit den untenstehenden Umgebungsvariablen können Sie das Ereignis ändern, das an den Usage Service gemeldet wird. Zum Beispiel können Sie die department- oder organization-Eigenschaften bei jedem Ereignis ändern, um die Nutzung von API oder CLI einem bestimmten Bereich oder einer Organisation zuzuordnen.

Die Kann überschreiben-Spalte gibt an, ob der in der Umgebungsvariable gesetzte Wert einen Wert überschreiben kann, der bereits programmgesteuert über die Metrikbibliothek festgelegt wurde. Ein Strich (—) in der Kann überschreiben-Spalte zeigt an, dass das Konzept für diese Variable nicht zutrifft.

Umgebungsvariablen

Name Typ Kann überschrieben werden Beschreibung
AXE_DISTINCT_ID String — Ein UUID-Identifikator, der für den angemeldeten Benutzer gleich bleibt (außer er wird neu generiert). In Ruby heißt diese Variable DEQUE_DISTINCT_ID.
AXE_INCLUDE_TEST_RESULTS Boolean — Setzen Sie true, um die vollständigen axe-core-Ergebnisse im testResults-Objekt jedes Ereignisses einzuschließen (Standard ist false). Wird nur von der CLI und den Node.js-APIs unterstützt.
AXE_METRICS_URL String — Die URL des REST-Nutzungsendpunkts (Standard ist https://usage.deque.com)
AXE_TRACK_USAGE Boolean — Setzen Sie false, um das Reporting des Nutzungsdienstes zu deaktivieren. Das Reporting ist standardmäßig aktiviert.
AXE_ACTOR String — Auf human oder automation setzen, um zu überschreiben, ob Ereignisse eine Person oder eine automatisierte Pipeline als Ausführende der Tests protokollieren. Standardmäßig wird automation aus den üblichen CI-Umgebungsvariablen ermittelt. Unterstützt von der CLI, den Node.js-APIs und nur der Ruby-API.
AXE_APPLICATION String false Die Anwendung, die verwendet wurde, um Barrierefreiheitsfehler zu überprüfen
AXE_DEV_INSTANCE Boolean true Zeigt an, ob dieses Ereignis durch die Aktionen eines Softwareentwicklers entstanden ist. Nützlich zum Markieren und späteren Entfernen von Ereignissen, die während der Entwicklung oder des Testens protokolliert wurden.
AXE_DEPARTMENT String true Die Abteilung des Benutzers innerhalb der Organisation
AXE_KEYCLOAK_ID String false Die Keycloak-ID des Benutzers
AXE_LOGGED_IN Boolean false Zeichnet auf, ob der Benutzer im zu testenden Anwendung angemeldet ist
AXE_ORGANIZATION String true Die Organisation des Benutzers. Um Ihre Nutzung in Axe Reports anzuzeigen, setzen Sie dies auf die ID Ihrer Organisation (kontaktieren Sie Deque, um diese zu erhalten).
AXE_SESSION_ID String false Ein UUID, das die Sitzung des Benutzers identifiziert
AXE_TEAMS String false Die Teams, die die Tests durchführen, als JSON-Array von { "id": "...", "name": "..." } Objekten oder der Pfad zu einer JSON-Datei, die eines enthält. Ein an die --set-teams-Option der CLI übergebener Wert, eine setTeams-Methode der Node.js-API oder eine for_teams-Klausel bzw. teams-Konfigurationseigenschaft der Ruby-API hat Vorrang. Unterstützt von der CLI, den Node.js-APIs und nur der Ruby-API.
AXE_USER_ID String false Die Identität eines bestimmten Benutzers, wie eine E-Mail-Adresse, ein Name oder eine Login-ID. Axe Reports zählt anhand dieses Wertes eindeutige Benutzer.
AXE_USER_JOB_ROLE String false Die Rolle des Benutzers im Beruf
AXE_USER_STATUS String false Statusinformationen, die Sie mit dem Benutzer verknüpfen möchten

Unterschiede zwischen den Sprachen

Die meisten dieser Umgebungsvariablen verhalten sich identisch in der CLI und jeder Axe DevTools API. Die Ausnahmen sind:

  • AXE_INCLUDE_TEST_RESULTS wird nur von der CLI und den Node.js-APIs gelesen. Das Setzen hat keinen Einfluss auf die Java-, Python-, C#- oder Ruby-APIs.
  • AXE_ACTOR und AXE_TEAMS werden nur von der CLI, den Node.js-APIs und der Ruby-API gelesen. Das Setzen hat keinen Einfluss auf die Java-, Python- oder C#-APIs.
  • In @axe-devtools/browser muss AXE_TEAMS ein JSON-Array sein und kein Dateipfad.
  • AXE_DISTINCT_ID wird in der Ruby API DEQUE_DISTINCT_ID genannt.
  • AXE_METRICS_URL fällt möglicherweise nicht auf seinen Standardwert in den Java- und Ruby-APIs zurück. Wenn Ihre Nutzungsevents Deque nicht erreichen, setzen Sie die Variable explizit auf https://usage.deque.com.

Siehe auch

Für Tutorials, die demonstrieren, wie diese Umgebungsvariablen genutzt werden, siehe Erste Schritte mit dem Nutzungsdienst und den APIs und Erste Schritte mit dem Usage-Service und der CLI.

Für allgemeine Informationen zum Usage Service siehe Der Axe DevTools für den Web Usage-Service.

Is this page helpful?

Help us improve this page

Still need help?