DISCLAIMER: A partire dall'inizio di gennaio 2024 la vecchia app Audit Trail non sarà più disponibile. La nuova funzionalità Audit Trail sarà l'unica disponibile e da utilizzare. Per chi ancora non è passato al nuovo Audit Trail consigliamo vivamente di farlo il prima possibile. Il nuovo Audit Trail è già disponibile e attivo.

Introduzione

Nel marzo 2021 la funzionalità Audit Trail è stata rinnovata per offrire un nuovo modo di gestire i dati di audit. 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'app (l'Audit Trail attuale si trova nel menu Report ed è un'app della piattaforma). Il nuovo Audit Trail include l'elenco completo degli eventi presenti nel vecchio Audit Trail da gennaio 2023.

La nuova funzionalità migliora la performance del processo di estrazione dei dati, in particolar modo per i clienti che operano con grandi database. L’interfaccia utente (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.

Attenzione! Il nuovo Audit Trail elenca tutti gli eventi che si sono verificati a partire da gennaio 2023. Il vecchio Audit Trail sarà dismesso all'inizio di gennaio 2024 e tutti gli eventi della vecchia app Audit Trail saranno archiviati e trasferiti al nuovo Audit Trail. Sarà comunque possibile accedervi dalla cartella Archivio.

Note Importanti per la Transizione Iniziale

La nuova funzionalità Audit Trail permette di tenere traccia delle azioni amministrative eseguite in piattaforma utilizzando il menu Audit Trail (a cui si accede tramite la sezione Impostazioni del Menu Amministrazione), beneficiando dall’esperienza rinnovata e dalle nuove funzionalità disponibili nel nuovo menu. L’attuale funzionalità Audit Trail sarà ancora accessibile e utilizzabile nel menu Report della propria piattaforma fino alla fine del 2023, ed è possibile utilizzare entrambi i menu, ma consigliamo vivamente di provare la nuova e migliorata funzionalità. È possibile utilizzare la nuova funzionalità di Audit Trail fin da subito, non è necessaria alcuna configurazione o attivazione!

La vecchia funzionalità Audit Trail non sarà rimossa dal menu Report, ma rimane in piattaforma per diversi motivi:

• La nuova funzionalità Audit Trail tiene traccia di tutti gli eventi a partire da gennaio 2023, ma non è possibile tenere traccia degli eventi verificatisi prima del rilascio della nuova Audit Trail.
• È possibile continuare a utilizzare il vecchio Audit Trail quando è necessario cercare eventi che hanno avuto luogo prima che la nuova funzionalità fosse resa disponibile. Dopo la dismissione della vecchia applicazione Audit Trail, gli eventi precedenti saranno archiviati e trasferiti al nuovo Audit Trail. Sarà comunque possibile accedervi dalla cartella Archivio.
• Chi ha costruito integrazioni con la vecchia app Audit Trail deve migrare queste integrazioni alle nuove API Audit Trail o tramite Webhook prima della dismissione della vecchia app Audit Trail.

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.

Per ogni nuova API, l’elenco dei parametri disponibili sarà dettagliato qui sotto e nell’API browser di Docebo.

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

Retrieves the logs generated from a specific extraction request

GET /audittrail/v1/audittrail/{query_execution_id} @get query_execution_id [string, required] ID of the requested extraction @parameter pageSize [integer, optional] Maximum number of results per page, min 1 and max 1000, default 20 @parameter nextToken [string, optional] Token generated that specifies from where to continue the pagination  

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 @get query_execution_id [integer, required] ID of the requested extraction