Het gebruik van de Usage Service regelen via Omgevingsvariabelen
Informatie over het gebruik van omgevingsvariabelen om de usage service te regelen of om het evenement dat aan de usage service wordt gerapporteerd te wijzigen
Dit artikel bevat informatie over hoe je de usage service kunt regelen via omgevingsvariabelen. Je kunt:
- Regel hoe de usage service werkt.
- Wijzig het evenement dat naar de usage service wordt verzonden.
Het gebruik van de Usage Service regelen via Omgevingsvariabelen
Deze vier omgevingsvariabelen stellen je in staat om de usage service te regelen. Je kunt het verzamelen van gebruiksstatistieken in- of uitschakelen, testresultaten opnemen in gebruiksgebeurtenissen, de URL wijzigen waar resultaten worden gerapporteerd, en de unieke ID van de gebruiker wijzigen.
| Naam | Beschrijving |
|---|---|
| AXE_DISTINCT_ID | Een uuid-identificator die hetzelfde blijft voor de ingelogde gebruiker (tenzij deze opnieuw wordt gegenereerd) |
| AXE_INCLUDE_TEST_RESULTS | Neem testresultaten op in het applicationProperties object door het testResults object te vullen |
| AXE_METRICS_URL | De URL van het REST-gebruikseindpunt |
| AXE_TRACK_USAGE | Schakelt rapportage van de usage service in (standaard is false) |
Als je client geen contact kan maken met de usage service, probeert hij opnieuw door https te vervangen door http in de URL (ingesteld met de AXE_METRICS_URL omgevingsvariabele).
Het gerapporteerde evenement wijzigen met Omgevingsvariabelen
Met de onderstaande omgevingsvariabelen kun je het evenement dat aan de usage service wordt gerapporteerd wijzigen. Je kunt bijvoorbeeld de afdeling of organisatie eigenschappen van elk evenement wijzigen om API- of CLI-gebruik aan een specifieke afdeling of organisatie te koppelen.
In de onderstaande tabellen geeft de Kan Overschrijven kolom aan of de in de omgevingsvariabele ingestelde waarde de waarde die is ingesteld in de oproep naar de metrische bibliotheek, kan overschrijven. Datanamen is de naam van de eigenschap zoals deze verschijnt in het evenement object dat naar de usage service wordt verzonden.
Booleaanse Omgevingsvariabelen
Deze waarden moeten zijn true of false.
| Naam | Datanamen | Kan Overschrijven | Beschrijving |
|---|---|---|---|
| AXE_DEV_INSTANCE | devInstance | waar | Geeft aan of dit evenement afkomstig is van de acties van een softwareontwikkelaar. Handig voor het markeren en later verwijderen van gebeurtenissen die tijdens ontwikkeling of testen zijn geregistreerd. |
| AXE_LOGGED_IN | ingelogd | onwaar | Registreert of de gebruiker is ingelogd in de applicatie die wordt getest. |
String Omgevingsvariabelen
Deze waarden worden geïnterpreteerd als strings.
| Naam | Gegevensnaam | Kan Overschrijven | Omschrijving |
|---|---|---|---|
| AXE_APPLICATION | applicatie | onwaar | De applicatie die werd gebruikt om te controleren op toegankelijkheidsfouten |
| AXE_DEPARTMENT | afdeling | waar | De afdeling van de gebruiker binnen de organisatie (AXE_ORGANIZATION) |
| AXE_KEYCLOAK_ID | keycloakId | onwaar | De gebruiker zijn Keycloak ID |
| AXE_ORGANIZATION | organisatie | waar | De organisatie van de gebruiker |
| AXE_SESSION_ID | sessieId | onwaar | Een uuid die de sessie van de gebruiker identificeert |
| AXE_USER_ID | gebruikerId | onwaar | De identiteit van een specifieke gebruiker, zoals naam of login-ID |
| AXE_USER_JOB_ROLE | gebruikersJobRol | onwaar | De functie van de gebruiker |
| AXE_USER_STATUS | gebruikersStatus | onwaar | Statusinformatie die u aan de gebruiker wilt koppelen |
Zie ook
Voor tutorials waarin wordt getoond hoe u deze omgevingsvariabelen kunt gebruiken, zie Aan de slag met de Usage Service en de API's en Aan de slag met de Usage Service en de CLI.
Voor algemene informatie over de usage service, zie De Axe DevTools voor Web Usage Service.