Steuern des Usage Service über Umgebungsvariablen
Informationen zur Verwendung von Umgebungsvariablen zur Steuerung des Usage Service oder zum Ändern des Ereignisses, das an den Usage Service gemeldet wird
In diesem Artikel erfahren Sie, wie Sie den Usage Service über Umgebungsvariablen steuern. Du kannst:
- Kontrolliere, wie der Usage Service funktioniert.
- Ändern Sie das Ereignis, das an den Nutzungsdienst gesendet wird.
Steuern des Usage Service über Umgebungsvariablen
Mit diesen vier Umgebungsvariablen können Sie den Nutzungsdienst steuern. Sie können die Erfassung von Nutzungsmetriken aktivieren oder deaktivieren, Testergebnisse in Nutzungsereignisse einbeziehen, die URL ändern, unter der die Ergebnisse gemeldet werden, und die eindeutige ID des Benutzers ändern.
| Name | Beschreibung |
|---|---|
| AXE_DISTINCT_ID | Eine UUID-Kennung, die für den angemeldeten Benutzer gleich bleibt (sofern sie nicht neu generiert wird) |
| AXE_INCLUDE_TEST_RESULTS | Fügen Sie Testergebnisse in das applicationProperties -Objekt auf, indem Sie das testResults -Objekt befüllen. |
| AXE_METRICS_URL | Die URL des REST-Endpunkts für die Nutzung |
| AXE_TRACK_NUTZUNG | Aktiviert die Berichterstattung über den Nutzungsdienst (die Standardeinstellung ist false) |
Wenn Ihr Client den Nutzungsdienst nicht kontaktieren kann, wird ein erneuter Versuch unternommen, indem in der URL (festgelegt mit der Umgebungsvariable AXE_METRICS_URL) https durch http ersetzt wird.
Ändern des gemeldeten Ereignisses mithilfe von Umgebungsvariablen
Mit den folgenden Umgebungsvariablen können Sie das Ereignis ändern, das dem Nutzungsdienst gemeldet wird. Sie können beispielsweise die Abteilungs oder Organisationseigenschaften bei jedem Ereignis ändern, um die API- oder CLI-Nutzung einer bestimmten Abteilung oder Organisation zuzuordnen.
In den folgenden Tabellen gibt die Spalte Kann überschrieben werden an, ob der in der Umgebungsvariablen festgelegte Wert den Wert überschreiben kann, der beim Aufruf der Metrikbibliothek festgelegt wurde. Datenname ist der Name der Eigenschaft, wie er im Ereignisobjekt erscheint, das an den Verwendungsdienst gesendet wird.
Boolesche Umgebungsvariablen
Diese Werte müssen true oder false sein.
| Name | Datenname | Kann überschrieben werden | Beschreibung |
|---|---|---|---|
| AXE_DEV_INSTANCE | devInstance | true | Gibt an, ob dieses Ereignis auf Aktionen eines Softwareentwicklers zurückzuführen ist. Nützlich zum Markieren und späteren Entfernen von Ereignissen, die während der Entwicklung oder des Tests protokolliert wurden. |
| AXE_LOGGED_IN | angemeldet | false | Protokolliert, ob der Benutzer bei der getesteten Anwendung angemeldet ist. |
String-Umgebungsvariablen
Diese Werte werden als Zeichenfolgen interpretiert.
| Name | Datenname | Kann überschrieben werden | Beschreibung |
|---|---|---|---|
| AXE_ANWENDUNG | Anwendung | false | Die Anwendung, die zur Überprüfung auf Barrierefreiheitsfehler verwendet wurde |
| AXE_DEPARTMENT | Abteilung | true | Die Abteilung des Benutzers innerhalb der Organisation (AXE_ORGANIZATION) |
| AXE_KEYCLOAK_ID | KeycloakId | false | Die Keycloak ID des Benutzers |
| AXE_ORGANISATION | Organisation | true | Die Organisation des Benutzers |
| AXE_SESSION_ID | Sitzungs-ID | false | Eine UUID, die die Sitzung des Benutzers identifiziert |
| AXE_USER_ID | Benutzer-ID | false | Eine bestimmte Benutzeridentität wie Name oder Anmelde-ID |
| AXE_USER_JOB_ROLE | benutzerjobrolle | false | Die berufliche Rolle des Benutzers |
| AXE_BENUTZER_STATUS | benutzerstatus | false | Statusinformationen, die Sie dem Benutzer zuordnen möchten |
Siehe auch
Tutorials zur Verwendung dieser Umgebungsvariablen finden Sie unter Erste Schritte mit dem Nutzungsdienst und den APIs und Erste Schritte mit dem Nutzungsdienst und der CLI.
Allgemeine Informationen zum Nutzungsdienst finden Sie unter The axe DevTools for Web Usage Service.