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
Drie omgevingsvariabelen stellen je in staat om de gebruiksservice te beheren. Je kunt het verzamelen van gebruiksstatistieken in- of uitschakelen, de URL wijzigen waar de resultaten worden gerapporteerd, en de unieke ID van de gebruiker veranderen.
Als je client geen contact kan maken met de gebruiksservice, zal deze opnieuw proberen door https te vervangen door http in de URL (ingesteld met behulp van de AXE_METRICS_URL omgevingsvariabele).
Het gerapporteerde evenement wijzigen met Omgevingsvariabelen
Met de onderstaande omgevingsvariabelen kun je het evenement wijzigen dat aan de gebruiksservice wordt gerapporteerd. Bijvoorbeeld, je kunt de eigenschappen afdeling of organisatie van elk evenement veranderen om API- of CLI-gebruik toe te wijzen aan een specifieke afdeling of organisatie.
De Kan Overschrijven-kolom geeft aan of de waarde, ingesteld in de omgevingsvariabele, een waarde kan overschrijven die al programmatisch via de metrics-bibliotheek was ingesteld. Een streepje (—) in de Kan Overschrijven-kolom geeft aan dat het concept niet van toepassing is op die variabele.
Omgevingsvariabelen
| Naam | Type | Kan Override | Beschrijving |
|---|---|---|---|
AXE_DISTINCT_ID |
String | — | Een UUID-identificator die hetzelfde blijft voor de ingelogde gebruiker (tenzij deze wordt opnieuw gegenereerd) |
AXE_METRICS_URL |
String | — | De URL van het REST-gebruikseindpunt |
AXE_TRACK_USAGE |
Boolean | — | Schakelt het rapporteren van gebruiksservices in (standaard is false) |
AXE_APPLICATION |
String | false | De applicatie die werd gebruikt om toegankelijkheidsfouten te controleren |
AXE_DEV_INSTANCE |
Boolean | true | Geeft aan of dit evenement afkomstig is van acties van een softwareontwikkelaar. Nuttig voor het markeren en later verwijderen van evenementen die tijdens ontwikkeling of testen zijn geregistreerd. |
AXE_DEPARTMENT |
String | true | De afdeling van de gebruiker binnen de organisatie |
AXE_KEYCLOAK_ID |
String | false | De Keycloak-ID van de gebruiker |
AXE_LOGGED_IN |
Boolean | false | Registreert of de gebruiker is ingelogd op de toepassing onder test |
AXE_ORGANIZATION |
String | true | De organisatie van de gebruiker |
AXE_SESSION_ID |
String | false | Een UUID die de sessie van de gebruiker identificeert |
AXE_USER_ID |
String | false | De identiteit van een specifieke gebruiker, zoals naam of inlog-ID |
AXE_USER_JOB_ROLE |
String | false | De functie van de gebruiker |
AXE_USER_STATUS |
String | false | Statusinformatie die u aan de gebruiker wilt koppelen |
Zie ook
Voor handleidingen die demonstreren hoe je 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 gebruiksservice, zie De Axe DevTools voor Web Usage Service.
