Introduzione
A partire da marzo 2021, la funzionalità Audit Trail verrà rinnovata, e offrirà un’esperienza di gestione degli audit log migliorata. La nuova funzionalità Audit Trail è stata progettata come una funzionalità a se stante (a cui si accede dalla sezione Impostazioni del Menu Amministrazione), al di fuori del contesto di un report e di un’applicazione (l’attuale Audit Trail si trova nel menu Report ed è un’app di piattaforma). Con la nuova funzionalità viene migliorata la performance del processo di estrazione dei dati, in particolar modo per i clienti che operano con grandi database. L’interfaccia utente dell’area (il nuovo menu Audit Trail) è stata ridisegnata in linea con il nuovo layout della piattaforma, e sono state apportate alcune modifiche importanti rispetto all’attuale funzionalità Audit Trail. Questo articolo elenca le modifiche introdotte dal rinnovamento di questa funzionalità e le API che sono state sviluppate per la nuova gestione degli Audit Trail.Gestione e Modifiche agli Audit Trail
Nell’attuale funzionalità Audit Trail, quando in qualità di Superadmin si crea un report Audit Trail, il sistema di filtri è complesso (nella prima pagina si filtra per utente, nella seconda per corso, nella terza per data e categoria di eventi e per i campi da mostrare) e diviso nelle varie pagine del processo di configurazione. Con la nuova funzionalità Audit Trail, il sistema è molto più semplice: dopo aver configurato i filtri desiderati dal pannello corrispondente e confermato la propria azione premendo Applica Filtri, la tabella del proprio audit log si aggiorna automaticamente utilizzando i filtri applicati. Il risultato della ricerca è immediatamente disponibile, senza dover passare attraverso diverse fasi di configurazione. Lo stesso accade quando si vogliono modificare uno o più filtri e visualizzare i risultati: nell’attuale funzionalità Audit Trail, si deve identificare il proprio report dalla tabella che elenca tutti i report personalizzati creati in piattaforma (nella parte inferiore della pagina Report), cliccare l’icona ellipsis e selezionare l’opzione Modifica, quindi passare attraverso tutte le fasi del processo di configurazione per modificare il filtro secondo le proprie necessità. Con la nuova funzionalità Audit Trail, per modificare i filtri impostati, basta aprire il pannello dei filtri e modificare i filtri secondo le proprie necessità, premere Applica Filtri, quindi la tabella nella pagina si aggiorna automaticamente utilizzando i filtri applicati.Opzioni Avanzate nei Filtri
Con la nuova funzionalità Audit Trail, cercare dati specifici diventa semplice e più intuitivo, e questo permette di notare un netto miglioramento a livello di performance. Grazie ai filtri avanzati disponibili nella nuova funzionalità, è possibile anche filtrare per target, e non solo per la persona o l’oggetto che ha svolto l’azione, migliorando e semplificando l’esperienza di utilizzo. Ad esempio, con l’attuale funzionalità Audit Trail, se il materiale didattico ABC è stato eliminato e si vuole includere questa azione nel proprio audit log, è possibile cercare solo l’utente che ha svolto l’azione, il corso coinvolto o la data in cui è accaduto l’evento. Potrebbe trattarsi di una ricerca lunga e complicata se si ricorda solo il nome del materiale didattico, ma non si hanno altre informazioni. Con la nuova funzionalità, è sufficiente cercare il nome del materiale didattico, ABC, tramite il filtro avanzato Target.Deprecazione delle Pianificazioni del Report Audit Trail
Con l’attuale funzionalità Audit Trail, dopo aver configurato il proprio report Audit Trail, si può decidere di pianificarlo, decidendo quanto spesso (ogni ora, giorno, settimana…) l’audit trail viene inviato agli indirizzi email che si aggiungono nel campo corrispondente della finestra di configurazione. Tuttavia, questa opzione è poco usata, e quindi non sarà più disponibile nella nuova funzionalità.Accesso all’Audit Trail
Nell’attuale funzionalità Audit Trail, nella parte inferiore della pagina Report sono elencati tutti i report creati nel contesto del menu (compresi gli audit trail, che sono creati utilizzando il menu dei report). Da qui, si può accedere agli audit log creati, e pianificarli, modificarli o eliminarli. Come già illustrato nella sezione introduttiva di questa guida, la nuova funzionalità Audit Trail è stata riprogettata come funzionalità a se stante e non è più un report, ma un log di tutte le azioni svolte in piattaforma in un dato periodo di tempo e corrispondente ai filtri impostati. Il menu Audit Trail quindi non mostra più la lista degli audit log creati, ma visualizza una tabella che elenca tutte le azioni svolte nel sistema, filtrate utilizzando il pannello filtri sulla sinistra della pagina. Nei prossimi mesi, aggiungeremo ulteriori opzioni nei filtri, i predefiniti, che permetteranno di salvare le diverse configurazioni di filtri e di applicarle rapidamente per filtrare le azioni mostrate nell’audit trail.Note Importanti per la Transizione Iniziale
Dopo il rilascio della nuova funzionalità Audit Trail, è possibile tenere traccia delle azioni amministrative svolte in piattaforma utilizzando il menu Audit Trail (a cui si accede tramite la sezione Impostazioni del Menu Amministrazione), traendo beneficio dall’esperienza rinnovata e dalle nuove funzionalità disponibili nel nuovo menu. L’attuale funzionalità Audit Trail è ancora accessibile e utilizzabile nel menu Report della propria piattaforma per alcuni mesi, e si possono utilizzare entrambi questi due menu, ma consigliamo vivamente di provare la nuova e migliorata funzionalità. Dal momento in cui il nuovo Audit Trail è disponibile nella propria piattaforma, è possibile iniziare subito ad utilizzarlo, dato che non è richiesta nessuna configurazione né attivazione. Dopo il rilascio della nuova funzionalità a marzo 2021, la vecchia funzionalità Audit Trail non verrà rimossa dal menu Report, ma rimane (e rimarrà per diversi mesi) in piattaforma per diversi motivi:- Con la nuova funzionalità, si potranno tracciare solo gli eventi avvenuti a partire dal momento in cui la nuova funzionalità è disponibile nella propria piattaforma, ma non si potranno tracciare gli eventi accaduti prima del rilascio del nuovo Audit Trail.
- Si continuerà ad utilizzare il vecchio report Audit Trail per cercare gli eventi avvenuti prima che la nuova funzionalità fosse resa disponibile. Poi, anche quando la vecchia funzionalità non sarà più disponibile (niente timore, non avverrà nella prima metà dell’anno 2021), daremo comunque la possibilità di avere accesso ai vecchi eventi. Purtroppo, per ragioni tecniche, non possiamo trasferire gli eventi dal vecchio Audit Trail al nuovo, ma, prima della deprecazione della vecchia funzionalità Audit Trail, rilasceremo una funzionalità che permetterà di svolgere ricerche ed estrazioni nel vecchio archivio.
- Si utilizzerà il vecchio Audit Trail per includere nel proprio audit log quegli eventi che non sono ancora disponibili nella nuova funzionalità Audit Trail. Alcuni degli eventi, infatti, non sono ancora selezionabili nella nuova funzionalità, ma stiamo lavorando per renderli disponibili tutti quanti, così da poter trovare tutti gli eventi nella nuova funzionalità entro un paio di mesi.
Nuove API
La tabella Nuove API mostra le nuove API disponibili per la nuova funzionalità Audit Trail. Queste API saranno operative a partire da marzo 2021.| Descrizione API | Verbo API | URL API |
|---|---|---|
| Creates a new extraction request of audit trails logs | POST | /audittrail/v1/audittrail |
| Retrieves the logs generated from a specific extraction request | GET | /audittrail/v1/audittrail/{query_execution_id} |
| Retrieves all the event types supported by the audit trail service | GET | /audittrail/v1/audittrail/event-types |
| Retrieves a CSV file of the requested extraction | GET | /audittrail/v1/audittrail/{query_execution_id}/download |
Creates a new extraction request of audit trails logs
POST /audittrail/v1/audittrail @parameter adminFilters [object, optional] Filter by one or more specific columns@item operatedById [object, optional] Filter by actor_id column
@item option [string, required] The type of condition to apply to the query
@item value [string, required] The value of the field
@item operatedBy [object, optional] Filter by actor column
@item option [string, required] The type of condition to apply to the query
@item value [string, required] The value of the field
@item targetId [object, optional] Filter by target_id column
@item option [string, required] The type of condition to apply to the query
@item value [string, required] The value of the field
@item target [object, optional] Filter by target column
@item option [string, required] The type of condition to apply to the query
@item value [string, required] The value of the field
@item ip [object, optional] Filter by ip column
@item option [string, required] The type of condition to apply to the query
@item value [string, required] The value of the field
@parameter eventType [array(string), optional] List of event names @parameter timeframe [object, optional]@item from [string, required] Event start date in UTC format
@item to[string, required] Event end date in UTC format