Controllo del Servizio di Utilizzo tramite Variabili di Ambiente
Informazioni sull'uso delle variabili di ambiente per controllare il servizio di utilizzo o per modificare l'evento che viene riportato al servizio di utilizzo
In questo articolo sono contenute informazioni su come controllare il servizio di utilizzo tramite variabili di ambiente. Puoi:
- Controllare come funziona il servizio di utilizzo.
- Modificare l'evento che viene inviato al servizio di utilizzo.
Controllo del Servizio di Utilizzo tramite Variabili di Ambiente
Queste quattro variabili di ambiente ti permettono di controllare il servizio di utilizzo. Puoi abilitare o disabilitare la raccolta delle metriche d'uso, includere i risultati del test con gli eventi d'uso, cambiare l'URL dove vengono riportati i risultati e cambiare l'ID distintivo dell'utente.
| Nome | Descrizione |
|---|---|
| AXE_DISTINCT_ID | Un identificativo uuid che rimane lo stesso per l'utente connesso (a meno che non venga rigenerato) |
| AXE_INCLUDE_TEST_RESULTS | Includi i risultati del test nell'oggetto applicationProperties popolando l'oggetto testResults |
| AXE_METRICS_URL | L'URL dell'endpoint REST di utilizzo |
| AXE_TRACK_USAGE | Abilita il servizio di reportistica d'uso (il valore predefinito è false) |
Se il tuo client non riesce a contattare il servizio d'uso, tenterà nuovamente sostituendo https con http nell'URL (impostato utilizzando la variabile di ambiente AXE_METRICS_URL).
Cambio dell'Evento Segnalato tramite Variabili di Ambiente
Con le variabili di ambiente sottostanti, puoi cambiare l'evento che viene riportato al servizio di utilizzo. Ad esempio, puoi modificare le proprietà dipartimento o organizzazione in ogni evento per associare l'uso delle API o CLI a un dipartimento o organizzazione specifica.
Nelle tabelle sottostanti, la colonna Può Sovrascrivere indica se il valore impostato nella variabile di ambiente può sovrascrivere il valore impostato nella chiamata alla libreria delle metriche. Nome dei Dati è il nome della proprietà come appare nell'oggetto evento inviato al servizio di utilizzo.
Variabili di Ambiente Booleane
Questi valori devono essere true o false.
| Nome | Nome dei Dati | Può Sovrascrivere | Descrizione |
|---|---|---|---|
| AXE_DEV_INSTANCE | devInstance | vero | Indica se questo evento è generato da azioni di un sviluppatore software. Utile per contrassegnare ed eventualmente rimuovere gli eventi registrati durante lo sviluppo o il test. |
| AXE_LOGGED_IN | loggedIn | falso | Registra se l'utente è connesso all'applicazione in fase di test. |
Variabili d'Ambiente per Stringhe
Questi valori sono interpretati come stringhe.
| Nome | Nome Dati | Può Sovrascrivere | Descrizione |
|---|---|---|---|
| AXE_APPLICATION | applicazione | falso | L'applicazione utilizzata per verificare gli errori di accessibilità |
| AXE_DEPARTMENT | reparto | vero | Il reparto dell'utente all'interno dell'organizzazione (AXE_ORGANIZATION) |
| AXE_KEYCLOAK_ID | keycloakId | falso | L'ID Keycloak dell'utente |
| AXE_ORGANIZATION | organizzazione | vero | L'organizzazione dell'utente |
| AXE_SESSION_ID | sessionId | falso | Un uuid che identifica la sessione dell'utente |
| AXE_USER_ID | userId | falso | L'identità specifica di un utente come nome o ID di accesso |
| AXE_USER_JOB_ROLE | userJobRole | falso | Il ruolo professionale dell'utente |
| AXE_USER_STATUS | userStatus | falso | Informazioni di stato che si desidera associare all'utente |
Vedi Anche
Per i tutorial che dimostrano come usare queste variabili d'ambiente, vedere Primi Passi con il Servizio di Utilizzo e le API e Introduzione al servizio di utilizzo e la CLI.
Per informazioni generali sul servizio di utilizzo, vedere Il servizio di utilizzo di Axe DevTools per il Web.