Controllo del Servizio di Utilizzo tramite variabili ambientali
Informazioni sull'utilizzo delle variabili di ambiente per controllare il Servizio di Utilizzo o per modificare l'evento segnalato al Servizio di Utilizzo
Questo articolo contiene informazioni su come controllare il servizio di utilizzo tramite variabili ambientali. Puoi:
- Controllare il funzionamento del servizio di utilizzo.
- Modificare l'evento inviato al servizio di utilizzo.
Controllo del Servizio di Utilizzo tramite variabili ambientali
Queste quattro variabili ambientali consentono di controllare il servizio di utilizzo. È possibile abilitare o disabilitare la raccolta di metriche di utilizzo, includere risultati di test con eventi di utilizzo, modificare l'URL in cui vengono segnalati i risultati e modificare l'ID univoco dell'utente.
| Nome | Descrizione |
|---|---|
| AXE_DISTINCT_ID | Un identificatore UUID che rimane lo stesso per l'utente registrato (a meno che non venga rigenerato) |
| AXE_INCLUDE_TEST_RESULTS | Includere i risultati del test nell'oggetto applicationProperties popolando l'oggetto testResults |
| AXE_METRICS_URL | L'URL dell'endpoint di utilizzo REST |
| AXE_TRACK_USAGE | Abilita la segnalazione del servizio di utilizzo (il valore predefinito è false) |
Se il client non riesce a contattare il servizio di utilizzo, riproverà sostituendo https con http nell'URL (impostato tramite la variabile di ambiente AXE_METRICS_URL).
Modifica dell'evento segnalato utilizzando le variabili di ambiente
Utilizzando le variabili di ambiente sottostanti è possibile modificare l'evento segnalato al servizio di utilizzo. Ad esempio, puoi modificare su ciascun evento le proprietà dipartimento o organizzazione per associare l'utilizzo dell'API o della CLI a un reparto o a un'organizzazione specifici.
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 del dato è il nome della proprietà così come appare nell'oggetto evento inviato al servizio di utilizzo.
Variabili d'ambiente booleane
Ci si aspetta che questi valori siano vero o falso.
| Nome | Nome del dato | Può annullare | Descrizione |
|---|---|---|---|
| AXE_DEV_INSTANCE | devInstance | vero | Indica se questo evento deriva dalle azioni di uno sviluppatore software. Utile per contrassegnare e successivamente rimuovere gli eventi registrati durante lo sviluppo o il test. |
| AXE_LOGGED_IN | loggato | falso | Registra se l'utente ha effettuato l'accesso all'applicazione sottoposta a test. |
Variabili d'ambiente stringa
Questi valori vengono interpretati come stringhe.
| Nome | Nome del dato | Può annullare | Descrizione |
|---|---|---|---|
| AXE_APPLICATION | applicazione | falso | L'applicazione utilizzata per verificare gli errori di accessibilità |
| AXE_DEPARTMENT | dipartimento | vero | Il reparto dell'utente all'interno dell'organizzazione (AXE_ORGANIZATION) |
| AXE_KEYCLOAK_ID | keycloakId | falso | ID Keycloak dell'utente |
| AXE_ORGANIZZAZIONE | organizzazione | vero | L'organizzazione dell'utente |
| AXE_SESSION_ID | ID sessione | falso | Un uuid che identifica la sessione dell'utente |
| AXE_USER_ID | ID utente | falso | L'identità di un utente specifico, come il nome o l'ID di accesso |
| AXE_USER_JOB_ROLE | Ruolo Lavoro Utente | falso | Il ruolo lavorativo dell'utente |
| AXE_UTENTE_STATUS | Stato dell'utente | falso | Informazioni sullo stato che vuoi associare all'utente |
Vedere anche
Per tutorial che mostrano come utilizzare queste variabili di ambiente, vedere Introduzione al servizio di utilizzo e alle API e Introduzione al servizio di utilizzo e alla CLI.
Per informazioni generali sul servizio di utilizzo, vedere The axe DevTools for Web Usage Service.