Het gebruik van de Usage Service regelen via Omgevingsvariabelen

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

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

Not for use with personal data

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

Vier omgevingsvariabelen stellen je in staat om de gebruiksservice te beheren. Je kunt het verzamelen van gebruiksstatistieken uitschakelen, de URL wijzigen waar resultaten worden gerapporteerd, de unieke ID van de gebruiker veranderen en de volledige axe-core resultaten in elk evenement opnemen.

important

Het rapporteren van gebruik is standaard ingeschakeld in de CLI en de Axe DevTools API's. Om te voorkomen dat gebruiksgebeurtenissen worden verzonden, stel AXE_TRACK_USAGE in op false, of roep de enableTracking methode van je API aan met false.

note

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). In Ruby is deze variabele genoemd DEQUE_DISTINCT_ID.
AXE_INCLUDE_TEST_RESULTS Boolean — Stel in op true om de volledige axe-core-resultaten op te nemen in het testResults-object van elk evenement (standaard is false). Wordt alleen ondersteund door de CLI en de Node.js API's.
AXE_METRICS_URL String — De URL van het REST-gebruikendpunt (standaard is https://usage.deque.com)
AXE_TRACK_USAGE Boolean — Stel in op false om rapportage van de gebruiksdienst uit te schakelen. Rapportage is standaard ingeschakeld.
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. Om uw gebruik in Axe Reports weer te geven, stel dit in op de ID van uw organisatie (neem contact op met Deque om deze te verkrijgen).
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 een e-mailadres, naam of inlog-ID. Axe Reports telt unieke gebruikers op basis van deze waarde.
AXE_USER_JOB_ROLE String false De functie van de gebruiker
AXE_USER_STATUS String false Statusinformatie die u aan de gebruiker wilt koppelen

Verschillen tussen talen

De meeste van deze omgevingsvariabelen gedragen zich identiek in de CLI en elke Axe DevTools API. De uitzonderingen zijn:

  • AXE_INCLUDE_TEST_RESULTS wordt alleen gelezen door de CLI en de Node.js API's. Het instellen ervan heeft geen effect op de Java, Python, C# of Ruby API's.
  • AXE_DISTINCT_ID wordt DEQUE_DISTINCT_ID genoemd in de Ruby API.
  • AXE_METRICS_URL kan mogelijk niet terugvallen op de standaardwaarde in de Java en Ruby API's. Als je gebruiksgebeurtenissen Deque niet bereiken, stel de variabele dan expliciet in op https://usage.deque.com.

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.

Is this page helpful?

Help us improve this page

Still need help?