Steuerung des Nutzungsdienstes über Umgebungsvariablen
Informationen zur Verwendung von Umgebungsvariablen zur Steuerung des Nutzungsdienstes oder zur Änderung des Ereignisses, das an den Nutzungsdienst gemeldet wird
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
Diese vier Umgebungsvariablen ermöglichen es Ihnen, den Nutzungsdienst zu steuern. Sie können die Erfassung von Nutzungsmetriken aktivieren oder deaktivieren, Testergebnisse in Nutzungsereignisse einschließen, die URL ändern, an die Ergebnisse gemeldet werden, und die eindeutige ID des Benutzers ändern.
| Name | Beschreibung |
|---|---|
| AXE_DISTINCT_ID | Ein UUID-Identifikator, der für den angemeldeten Benutzer gleich bleibt (es sei denn, er wird neu generiert) |
| AXE_INCLUDE_TEST_RESULTS | Testergebnisse in das applicationProperties Objekt aufnehmen, indem das testResults Objekt gefüllt wird |
| AXE_METRICS_URL | Die URL des REST-Nutzungsendpunkts |
| AXE_TRACK_USAGE | Ermöglicht die Berichterstattung des Nutzungsdienstes (Standard ist false) |
Wenn Ihr Client den Nutzungsdienst nicht kontaktieren kann, wird er einen erneuten Versuch unternehmen, indem er https durch http in der URL ersetzt (eingerichtet durch die AXE_METRICS_URL-Umgebungsvariable).
Änderung des gemeldeten Ereignisses mittels Umgebungsvariablen
Mit den unten aufgeführten Umgebungsvariablen können Sie das Ereignis ändern, das an den Nutzungsdienst gemeldet wird. Zum Beispiel können Sie die Abteilung oder die Organisation -Eigenschaften bei jedem Ereignis ändern, um die Verwendung von APIs oder CLI-Befehlen einer bestimmten Abteilung oder Organisation zuzuordnen.
In den untenstehenden Tabellen gibt die Kann überschreiben -Spalte an, ob der in der Umgebungsvariable festgelegte Wert den bei dem Aufruf an die Metrikbibliothek festgelegten Wert überschreiben kann. Datenname ist der Name der Eigenschaft, wie sie im an den Nutzungsdienst gesendeten Ereignisobjekt erscheint.
Boolesche Umgebungsvariablen
Diese Werte sollten sein true oder false.
| Name | Datenname | Kann überschreiben | Beschreibung |
|---|---|---|---|
| AXE_DEV_INSTANCE | devInstance | true | Gibt an, ob dieses Ereignis aus Handlungen eines Softwareentwicklers stammt. Nützlich zum Markieren und späteren Entfernen von Ereignissen, die während der Entwicklung oder Testphase protokolliert wurden. |
| AXE_LOGGED_IN | loggedIn | false | Zeichnet auf, ob der Benutzer in der zu testenden Anwendung angemeldet ist. |
String-Umgebungsvariablen
Diese Werte werden als Zeichenketten interpretiert.
| Name | Datenname | Kann überschreiben | Beschreibung |
|---|---|---|---|
| AXE_APPLICATION | application | false | Die Anwendung, die zur Überprüfung auf Barrierefreiheitsfehler verwendet wurde |
| AXE_DEPARTMENT | department | true | Die Abteilung des Benutzers innerhalb der Organisation (AXE_ORGANIZATION) |
| AXE_KEYCLOAK_ID | keycloakId | false | Die Keycloak -ID des Benutzers |
| AXE_ORGANIZATION | organization | true | Die Organisation des Benutzers |
| AXE_SESSION_ID | sessionId | false | Eine UUID, die die Sitzung des Benutzers identifiziert |
| AXE_USER_ID | userId | false | Die Identität eines bestimmten Benutzers wie Name oder Login-ID |
| AXE_USER_JOB_ROLE | userJobRole | false | Die Berufsrolle des Benutzers |
| AXE_USER_STATUS | userStatus | false | Statusinformationen, die Sie mit dem Benutzer verknüpfen möchten |
Siehe auch
Für Tutorials, die zeigen, wie man diese Umgebungsvariablen verwendet, siehe Erste Schritte mit dem Nutzungsdienst und den APIs und Erste Schritte mit dem Usage-Service und der CLI.
Allgemeine Informationen zum Usage-Service finden Sie unter Der Axe DevTools für den Web Usage-Service.