Introduzione
A partire dal 27 Ottobre 2020, l’area della piattaforma dedicata alla gestione dei gruppi offre una nuova esperienza di gestione dei gruppi di utenti in piattaforma.
Grazie a questa rinnovamento, l’interfaccia utente dell’area è stata ridisegnata in linea con il nuovo layout della piattaforma, e sono state apportate alcune modifiche fra rispetto alla gestione attuale.
Questo articolo elenca le modifiche introdotte dal rinnovamento, le API dismesse e sviluppate per la nuova gestione, e fornisce informazioni su come effettuare l'upgrade alla nuova gestione.
Ricalcolo delle Condizioni per tutti gli Utenti
Con la vecchia gestione dei gruppi autopopolati, se il Superadmin modifica una condizione di popolamento del gruppo, può decidere di non applicare la nuova condizione agli utenti che già fanno parte del gruppo (non abilitando l’opzione Applica anche agli utenti che soddisfano le condizioni riportate qui sopra).
Ancora una volta, questo scenario genera inconsistenza fra gli utenti del gruppo e le condizioni definite per il popolamento del gruppo stesso.
Con la nuova gestione dei gruppi, la piattaforma ricalcola la popolazione del gruppo da zero ogni volta che si modifica una condizione. Il ricalcolo assegnerà gli utenti al gruppo solo se effettivamente soddisfano il nuovo set di condizioni, garantendo consistenza.
Nuove Condizioni, Gestite in Set
Con la vecchia gestione dei gruppi, le condizioni dei gruppi autopopolati si basano unicamente sui campi aggiuntivi degli utenti. Quando si definiscono più condizioni, è possibile definire se tutte, o almeno una condizione devono essere rispettate per includere gli utenti nel gruppo.
La nuova gestione degli utenti introduce due nuove condizioni per il popolamento automatico dei gruppi: lo stato di iscrizione e il ramo di appartenenza. È possibile definite fino a 10 condizioni, e raggrupparle in set, per un massimo di 10 set. Tutte le condizioni incluse in un set devono essere soddisfatte, mentre è possibile definire una logica fra set, in modo che tutti, o almeno un set debba essere soddisfatto per poter inserire gli utenti al gruppo.
Condizione Basate sul Ruolo dell’Utente
Per coloro che usufruiscono dell’integrazione con il modulo Perform, la gestione attuale dei gruppi autopopolati permette di definire delle condizioni basate sul ruolo dell’utente.
Poiché il modulo Perform non è più disponibile, non sarà più possibile usufruire di questa condizione nella nuova gestione dei gruppi.
Passare alla Nuova Gestione dei Gruppi
L'upgrade alla nuova gestione dei gruppi non è eseguita automaticamente, e sarà possibile migrare in qualsiasi momento fra il 27 Ottobre 2020 e il 2 Febbraio 2021.
Per passare alla nuova gestione, cliccare Upgrade nel banner visualizzato nella parte superiore della pagina Gestione Gruppi.
Al momento dell'upgrade alla nuova gestione dei gruppi, sia i gruppi manuali che i gruppi automatici definiti in piattaforma saranno portati alla nuova gestione dei gruppi, con gli utenti attualmente associati ai gruppi. Il popolamento dei gruppi automatici sarà ricalcolato in base alle regole definite al momento della creazione del gruppo al momento del primo salvataggio del gruppo stesso.
Questa operazione potrebbe richiedere del tempo, e non è annullabile. Dopo l'upgrade, non sarà possibile tornare alla precedente versione della gestione dei gruppi.
Il 2 Febbraio 2021, la nuova versione della gestione dei gruppi sarà abilitata si tutte le piattaforme, e non sarà più possibile tornare indietro. Assicurati di attivare manualmente la nuova gestione dei gruppi prima di questa data.
API Dismesse
La tabella API Dismesse elenca tutte le API che saranno dismesse per via della nuova gestione dei gruppi. Queste API rimarranno operative per sei mesi dopo il rilascio della funzionalità, fino alla fine di Aprile 2021, in modo da offrire abbastanza tempo per migrare alle nuove API. Al termine di questo periodo, Docebo continuerà a garantire la gestione delle vecchie API, ma non saranno più mantenute allineate a sviluppi e migliorie future.
API Description | API Verb | API URL |
---|---|---|
Creazione gruppo | POST | /manage/v1/group |
Cancellazione gruppo | DELETE | /manage/v1/group/{id} |
Aggiornamento gruppo | PUT | /manage/v1/group/{id} |
Cancellazione del membro di un gruppo | DELETE | /manage/v1/group/{id_group}/members/{id_user} |
Inserimento di un membro nel gruppo | POST | /manage/v1/group/{id_group}/members |
Cancellazione batch dei membri di un gruppo | DELETE | /manage/v1/group/members/batch |
Import batch dei membri di un gruppo | POST | /manage/v1/group/members/batch |
Import batch dei gruppi | POST | /manage/v1/group/batch |
Elenco dei dettagli di un gruppo | GET | /manage/v1/group/(id_group) |
Nuove API
La tabella Nuove API elenca le API disponibili per la nuova gestione dei gruppi. Questa API saranno operative a partire dal 27 Ottobre 2020.
API Description | API Verb | API URL |
---|---|---|
Elenco di tutti i gruppi | GET | /audiences/v1/audience |
Creazione di un nuovo gruppo | POST | /audiences/v1/audiences |
Cancellazione di un gruppo in base all’ID | DELETE | /audiences/v1/audience/{uuid} |
Elenco di un gruppo | GET | /audiences/v1/audience/{uuid} |
Aggiornamento di un gruppo | PUT | /audiences/v1/audience/{uuid} |
Elenco degli utenti di un gruppo | GET | /audiences/v1/audience/{uuid}/users |
Rimozione degli utenti da un gruppo | DELETE | /audiences/v1/audience/{uuid}/users |
Inserimento degli utenti in un gruppo | POST | /audiences/v1/audience/{uuid}/users |
Export del CSV con l’elenco degli utenti di un gruppo | GET | /audiences/v1/audience/{uuid}/export-users |
Recupero della cronologia di un gruppo automatico | GET | /audiences/v1/audience/{uuid}/conditions-history |
Recupero dell'ID di un vecchio gruppo dall'ID di un nuovo gruppo | GET | /audiences/v1/audience/{uuid}/audience_to_group |
Recupero dell'ID di un nuovo gruppo dall'ID di un vecchio gruppo | GET | /audiences/v1/audience/{id}/group_to_audience |
Per ogni API, l’elenco dei parametri è dettagliato nelle sezioni che seguono
Elenco di tutti i gruppi
GET /audiences/v1/audience @parameter sort_attr [string, optional] : Ordine dei gruppi in base alla proprietà. I valori possibili sono: “name”, “description”, “slug” @parameter sort_dir [string, optional] : Direzione dell'ordinamento. Sort direction. I valori possibili sono: “asc”, “desc” @parameter page [number, optional] : Pagina da restiturire. Default: 1 @parameter page_size [number, optional] : Elementi da restituire. @parameter search_text [string, optional] : Ricerca gruppi per chiave, nome e descrizione.
Elenco di un gruppo
GET /audiences/v1/audience/{uuid} @get uuid [string, required] : ID della risorsa da restituire.
Creazione gruppo
POST /audiences/v1/audiences @parameter name [string, required] : Nome del gruppo @parameter description [string, optional] : Descrizione del gruppo @parameter type [string, required] : Tipo di gruppo. I valori possibili sono: “manual”, ”automatic” @parameter ruleset [object, optional] : Definizione del set di regole (necessario per i gruppi automatici) @item operator [string, required] : Operatore del set di regole. I valori possibili sono: “AND”, ”OR” @item sets [array, required] : Set di regole @item rules [array, required] : Regole del set @item type [string, required] : Tipo di regola @item payload [object, required] : Payload della regola @end @end @end
Aggiornamento gruppo
PUT /audiences/v1/audience/{uuid} @parameter name [string, optional] : Nome del gruppo @parameter description [string, optional] : Descrizione del gruppo @parameter ruleset [object, optional] : Definizione del set di regole (necessario per i gruppi automatici) @item operator [string, required] : Operatore del set di regole. I valori possibili sono: “AND”, ”OR” @item sets [array, required] : Set di regole @item id [string, optional] : Identificativo del set @item rules [array, required] : Regole del set @item id [string, optional] : Identificativo della regola @item type [string, required] : Tipo di regola @item payload [object, required] : Payload della regola @end @end @end
Rimozione degli utenti da un gruppo
DELETE /audiences/v1/audience/{uuid}/users @parameter user_ids [array(integer), required] Utenti da rimuovere dal gruppo @parameter user_all [bool, optional] Rimuovere tutti gli utenti dal gruppo @parameter user_filters [array(string), optional] Rimozione dal gruppo di tutti gli utenti che soddisfano il criterio ( "search" = "test" )
Cancellazione gruppo
DELETE /audiences/v1/audience/{uuid} @get uuid [string, required] : ID delle risorse da cancellare
Elenco degli utenti di un gruppo
GET /audiences/v1/audience/{uuid}/users @get uuid [string, required] : ID della risorsa gruppo @parameter sort_attr [string, optional] Campo di ordinamento. I valori possibili sono: “idst”, “userid”, “firstname”, “lastname”, “email”. Default value: “idst” @parameter page [number, optional] : Pagina da restituire. Default: 1 @parameter page_size [number, optional] : Elementi da resistuire. @parameter search_text [string, optional] : Ricerca utenti in base ai valori: first name, last name, email e username
Inserimento utenti in un gruppo
PUT /audiences/v1/audience/{uuid}/users @parameter user_ids [array(integer), optional] : Utenti da aggiungere al gruppo (Almeno ad un gruppo, i rami o gli utenti devono essere definiti) @parameter branch_ids [array(integer), optional] : Rami da aggiungere al gruppo (Almeno ad un gruppo, i rami o gli utenti devono essere definiti) @parameter group_ids [array(integer), optional] : Copia gli utenti di un altro gruppo, nel gruppo selezionato (Almeno ad un gruppo, i rami o gli utenti devono essere definiti)
Export degli utenti che appartengono ad un gruppo
GET /audiences/v1/audience/{uuid}/export-users @parameter userid [boolean, optional] : Se l'ID utente deve essere incluso dell'export. Default: false @parameter firstname [boolean, optional] : Se il nome dell'utente deve essere incluso dell'export. Default: false @parameter lastname [boolean, optional] : Se il cognome dell'utente deve essere incluso dell'export. Default: false @parameter email [boolean, optional] : Se l'email dell'utente deve essere incluso dell'export. Default: false @parameter include_header [boolean, optional] : Se includere o NO i nomi delle colonne nel file CSV. Default: false @parameter delimiter [string, optional] : Delimitatore per i file CSV esportati. Default: ","
Recupero delle condizioni della cronologia di un gruppo
GET /audiences/v1/audience/{uuid}/conditions-history @get uuid [string, required] : ID della risorsa da recuperare
Recupero dell'ID di un vecchio gruppo dall'ID di un nuovo gruppo
GET /audiences/v1/audience/{uuid}/audience_to_group @get id [string, required] ID della risorsa del nuovo gruppo da cui recuperare l'ID del vecchio gruppo
Recupero dell'ID di un nuovo gruppo dall'ID di un vecchio gruppo
GET /audiences/v1/audience/{id}/group_to_audience @get id [integer, required] ID della risorsa del vecchio gruppo da cui recuperare l'ID del nuovo gruppo