Contrôler le service d'utilisation via des variables d'environnement
Informations sur l'utilisation des variables d'environnement pour contrôler le service d'utilisation ou pour modifier l'événement rapporté au service d'utilisation
Cet article contient des informations sur la façon de contrôler le service d'utilisation via des variables d'environnement. Vous pouvez :
- Contrôler le fonctionnement du service d'utilisation.
- Modifier l'événement envoyé au service d'utilisation.
Contrôler le service d'utilisation via des variables d'environnement
Ces quatre variables d'environnement vous permettent de contrôler le service d'utilisation. Vous pouvez activer ou désactiver la collecte des métriques d'utilisation, inclure les résultats des tests avec les événements d'utilisation, changer l'URL où les résultats sont rapportés, et changer l'ID distinct de l'utilisateur.
| Nom | Description |
|---|---|
| AXE_DISTINCT_ID | Un identifiant uuid qui reste le même pour l'utilisateur connecté (sauf s'il est régénéré) |
| AXE_INCLUDE_TEST_RESULTS | Inclure les résultats des tests dans l'objet applicationProperties en remplissant l'objet testResults |
| AXE_METRICS_URL | L'URL du point de terminaison REST d'utilisation |
| AXE_TRACK_USAGE | Active le rapport du service d'utilisation (la valeur par défaut est false) |
Si votre client n'est pas en mesure de contacter le service d'utilisation, il tentera à nouveau en remplaçant https par http dans l'URL (définie à l'aide de la variable d'environnement AXE_METRICS_URL).
Modifier l'événement rapporté à l'aide de variables d'environnement
Avec les variables d'environnement ci-dessous, vous pouvez changer l'événement qui est rapporté au service d'utilisation. Par exemple, vous pouvez changer les propriétés département ou organisation sur chaque événement pour associer l'utilisation de l'API ou de l'interface de ligne de commande à un département ou une organisation spécifique.
Dans les tableaux ci-dessous, la colonne Peut remplacer indique si la valeur définie dans la variable d'environnement peut remplacer la valeur qui a été définie dans l'appel à la bibliothèque de métriques. Nom des données est le nom de la propriété telle qu'elle apparaît dans l'objet événement envoyé au service d'utilisation.
Variables d'environnement booléennes
Ces valeurs sont censées être true ou false.
| Nom | Nom des données | Peut remplacer | Description |
|---|---|---|---|
| AXE_DEV_INSTANCE | devInstance | vrai | Indique si cet événement provient d'actions d'un développeur logiciel. Utile pour marquer et supprimer ultérieurement les événements enregistrés pendant le développement ou le test. |
| AXE_LOGGED_IN | loggedIn | faux | Enregistre si l'utilisateur est connecté à l'application en test. |
Variables d'environnement de type chaîne
Ces valeurs sont interprétées comme des chaînes.
| Nom | Nom des données | Peut remplacer | Description |
|---|---|---|---|
| AXE_APPLICATION | application | faux | L'application qui a été utilisée pour vérifier les erreurs d'accessibilité |
| AXE_DEPARTMENT | department | vrai | Le département de l'utilisateur au sein de l'organisation (AXE_ORGANIZATION) |
| AXE_KEYCLOAK_ID | keycloakId | faux | L' ID Keycloak de l'utilisateur |
| AXE_ORGANIZATION | organization | vrai | L'organisation de l'utilisateur |
| AXE_SESSION_ID | sessionId | faux | Un uuid identifiant la session de l'utilisateur |
| AXE_USER_ID | userId | faux | L'identité spécifique d'un utilisateur tel que le nom ou l'ID de connexion |
| AXE_USER_JOB_ROLE | userJobRole | faux | Le rôle professionnel de l'utilisateur |
| AXE_USER_STATUS | userStatus | faux | Informations de statut que vous souhaitez associer à l'utilisateur |
Voir aussi
Pour des tutoriels montrant comment utiliser ces variables d'environnement, voyez Prise en main avec le service d'utilisation et les API et Premiers pas avec le service d'utilisation et le CLI.
Pour des informations générales sur le service d'utilisation, voir Axe DevTools for Web Service d'utilisation.