Introduction
Depuis le 27 octobre 2020, l’espace gestion des groupes de votre plateforme a été amélioré afin de vous proposer une façon complètement renouvelée de gérer les groupes d’utilisateurs.
L’interface utilisateur de cet espace a été retravaillée en fonction de la nouvelle structure de la plateforme et un nombre important de changements entre la manière actuelle et la nouvelle manière de gérer les groupes a été apporté.
Cet article liste les changements introduits par l’amélioration de cette fonctionnalité, les APIs qui ont été abandonnés et ceux développés pour la nouvelle gestion des groupes et explique comment migrer vers la nouvelle gestion des groupes.
Recalcul des Conditions pour Tous les Utilisateurs
Lorsque vous utilisez l’ancienne version des groupes auto-remplis, si un Superadmin modifie une des conditions de remplissage du groupe, il/elle peut décider de ne pas appliquer la nouvelle condition aux utilisateurs déjà présents dans le groupe (en choisissant de ne pas activer l’option Appliquer aux utilisateurs existants qui remplissent les conditions ci-dessus)
Cette possibilité génère des incohérences entre les utilisateurs du groupe et les conditions définies pour le remplissage du groupe.
Avec la nouvelle gestion des groupes, à chaque fois qu’une condition est modifiée, la plateforme remplit à nouveau le groupe en partant de zéro. Le nouveau calcul attribue ensuite les utilisateurs au groupe uniquement s’ils correspondent aux nouvelles conditions, assurant ainsi la cohérence.
Nouvelles Conditions, Gérées par Ensembles
Avec l’ancienne version des groupes, les conditions pour le remplissage automatique des groupes se basent sur les champs supplémentaires utilisateur uniquement. Lorsque vous définissez plus d’une condition, vous pouvez choisir si toutes ou au moins une des conditions doit être satisfaite pour que les utilisateurs soient ajoutés au groupe.
La nouvelle version des groupes introduit deux nouvelles conditions pour le remplissage automatique des groupes : le statut d’inscription et la branche d’appartenance. Vous pouvez définir jusqu’à 10 conditions et les regrouper dans des ensembles, avec un maximum de 10 ensembles. Toutes les conditions incluses dans un ensemble doivent être satisfaites alors que la logique entre les ensembles peut être définie de sorte que tous les ensembles ou au moins un doivent être satisfait pour que les utilisateurs soient ajoutés au groupe.
Conditions Basées sur le Rôle de l’Utilisateur
Lorsque vous bénéficiez d’une intégration avec le module Perform, l’ancienne gestion du remplissage automatique des groupes permet la définition de conditions basées sur le rôle de l’utilisateur.
Le module Perform n’étant plus disponible, cette condition n’a pas été reprise dans la nouvelle gestion des groupes.
Mise à Niveau vers la Nouvelle Gestion des Groupes
La mise à niveau vers la nouvelle gestion des groupes ne se fait pas automatiquement mais vous pouvez le faire à tout moment après le 27 octobre 2020 et avant le 2 février 2021.
Afin d’effectuer la mise à jour vers la nouvelle gestion des groupes, cliquez sur le bouton Mettre à Niveau dans la bannière affichée en haut de la page Groupes.
Lors de la mise à niveau vers la nouvelle Gestion des Groupes, les groupes automatiques et manuels définis sur la plateforme sont transférés vers la Gestion des Groupes avec leur remplissage actuel. Le remplissage des groupes automatiques est recalculé à partir de zéro en fonction des règles que vous avez définies pour le groupe lorsque vous enregistrez le groupe pour la première fois.
Cette opération peut prendre un certain temps à s’exécuter et ne peut pas être annulée. Après la mise à niveau, vous ne pourrez plus revenir à l'ancienne version des groupes.
Le 2 février 2021, la mise à niveau de la gestion des groupes s’exécutera sur toutes les plateformes et il ne sera pas possible de revenir en arrière. Assurez-vous d’activer manuellement la nouvelle gestion des groupes avant cette date.
APIs Obsolètes
La liste des APIs Obsolètes répertorie tous les APIs qui deviennent obsolètes avec la nouvelle gestion des groupes. Veuillez noter que ces API restent opérationnelles pendant six mois après la publication de la fonctionnalité, jusqu’à fin avril 2021, pour vous laisser assez de temps pour migrer vers les nouvelles APIs. Après cette période, Docebo continuera à assurer la maintenance des anciennes APIs mais elles cesseront d’être alignées avec les futurs développements et améliorations.
Description API |
Verbe API |
URL API |
Créer un groupe |
POST |
/manage/v1/group |
Supprimer un groupe |
DELETE |
/manage/v1/group/{id} |
Mettre à jour un groupe |
PUT |
/manage/v1/group/{id} |
Supprimer un membre d’un groupe |
DELETE |
/manage/v1/group/{id_group}/members/{id_user} |
Ajouter un membre à un groupe |
POST |
/manage/v1/group/{id_group}/members |
Supprimer des membres à un groupe en masse |
DELETE |
/manage/v1/group/members/batch |
Importer des membres dans un groupe en masse |
POST |
/manage/v1/group/members/batch |
Importer des groupes en masse |
POST |
/manage/v1/group/batch |
Obtenir les détails d’un groupe |
GET |
/manage/v1/group/(id_group) |
Nouvelles APIs
Le tableau Nouvelles APIs répertorie les nouvelles APIs disponibles pour la nouvelle gestion des groupes. Ces APIs seront entièrement opérationnelles à partir du 27 octobre 2020.
Description API |
Verbe API |
URL API |
Obtenir tous les groupes |
GET |
/audiences/v1/audience |
Créer un nouveau groupe |
POST |
/audiences/v1/audiences |
Supprimer un groupe en fonction de son ID |
DELETE |
/audiences/v1/audience/{uuid} |
Obtenir un groupe spécifique |
GET |
/audiences/v1/audience/{uuid} |
Mettre à jour un groupe |
PUT |
/audiences/v1/audience/{uuid} |
Obtenir les utilisateurs d’un groupe |
GET |
/audiences/v1/audience/{uuid}/users |
Supprimer des utilisateurs d’un groupe |
DELETE |
/audiences/v1/audience/{uuid}/users |
Ajouter des utilisateurs à un groupe |
POST |
/audiences/v1/audience/{uuid}/users |
Exporter un fichier CSV contenant tous les utilisateurs d’un groupe |
GET |
/audiences/v1/audience/{uuid}/export-users |
Récupérer l’historique des groupes automatiques |
GET |
/audiences/v1/audience/{uuid}/conditions-history |
Obtenir un ancien ID de groupe à partir d’un nouvel ID de groupe |
GET |
/audiences/v1/audience/{uuid}/audience_to_group |
Obtenir un nouvel ID de groupe à partir d’un ancien ID de groupe |
GET |
/audiences/v1/audience/{id}/group_to_audience |
Pour chaque API, la liste des paramètres est détaillée dans les sections suivantes.
Obtenir tous les groupes
GET /audiences/v1/audience @parameter sort_attr [string, optional] : Classer les groupes en fonction de la propriété. Valeurs possibles : “name”, “description”, “slug” @parameter sort_dir [string, optional] : Direction du tri. Valeurs possibles: “asc”, “desc” @parameter page [number, optional] : Page à retourner. Default: 1 @parameter page_size [number, optional] : Elements à retourner. @parameter search_text [string, optional] : Recherche de groupe par clé, nom et description
Obtenir un groupe spécifique
GET /audiences/v1/audience/{uuid} @get uuid [string, required] : L’ID de la ressource à récupérer
Créer un groupe
POST /audiences/v1/audiences @parameter name [string, required] : Le nom du groupe @parameter description [string, optional] : La description du groupe @parameter type [string, required] : Le type de groupe. Valeurs possibles : “manual”, ”automatic” @parameter ruleset [object, optional] : La définition de l’ensemble de règles (nécessaire pour les groupes automatiques) @item operator [string, required] : L’opérateur pour l’ensemble de règle. Valeurs possibles : “AND”, ”OR” @item sets [array, required] : L’ensemble de règles @item rules [array, required] : Les règles de l’ensemble @item type [string, required] : Le type de règle @item payload [object, required] : Les données utiles de la règle @end @end @end
Mettre à jour un groupe
PUT /audiences/v1/audience/{uuid} @parameter name [string, optional] : Le nom du groupe @parameter description [string, optional] : La description du groupe @parameter ruleset [object, optional] : La définition de l’ensemble de règles (nécessaire pour les groupes automatiques) @item operator [string, required] : L’opérateur de l’ensemble de règles Valeurs possibles : “AND”, ”OR” @item sets [array, required] : L’ensemble de règles @item id [string, optional] : L’identifiant de l’ensemble @item rules [array, required] : Les règles de l’ensemble @item id [string, optional] : L'identifiant de la règle @item type [string, required] : Le type de règle @item payload [object, required] : Les éléments utiles de la règle @end @end @end
Supprimer des utilisateurs d’un groupe spécifique
DELETE /audiences/v1/audience/{uuid}/users @parameter user_ids [array(integer), required] Utilisateurs à supprimer d’un groupe @parameter user_all [bool, optional] Supprimer tous les utilisateurs du groupe @parameter user_filters [array(string), optional] Supprimer les utilisateurs qui répondent au critère ( "search" = "test" ) du groupe
Supprimer un groupe
DELETE /audiences/v1/audience/{uuid} @get uuid [string, required] : L’ID de la ressource à supprimer
Obtenir les utilisateurs d’un groupe
GET /audiences/v1/audience/{uuid}/users @get uuid [string, required] : L’ID d’un groupe resource @parameter sort_attr [string, optional] : Classer en fonction de ce champ. Valeurs possibles : “idst”, “userid”, “firstname”, “lastname”, “email”. Valeur par défaut : “idst” @parameter page [number, optional] : Page à retourner. Default: 1 @parameter page_size [number, optional] : Éléments à retourner. @parameter search_text [string, optional] : Recherche d’utilisateurs par prénom, nom, email et nom d’utilisateur
Ajouter un utilisateur à un groupe spécifique
PUT /audiences/v1/audience/{uuid}/users @parameter user_ids [array(integer), optional] : Les utilisateurs à ajouter au groupe (Au moins un des groupes, branches ou utilisateurs doit être défini) @parameter branch_ids [array(integer), optional] : Les branches à ajouter au groupe (Au moins un des groupes, branches ou utilisateurs doit être défini) @parameter group_ids [array(integer), optional] : Copier les utilisateurs actuellement dans un autre groupe dans ce groupe (Au moins un des groupes, branches ou utilisateurs doit être défini)
Exporter les utilisateurs appartenant à un groupe spécifique
GET /audiences/v1/audience/{uuid}/export-users @parameter userid [boolean, optional] : Si l’ID utilisateur doit être inclus dans l’export - Default: false @parameter firstname [boolean, optional] : Si le prénom de l’utilisateur doit être inclus dans l’export - Default: false @parameter lastname [boolean, optional] : Si le nom de l’utilisateur doit être inclus dans l’export - Default: false @parameter email [boolean, optional] : Si l’adresse email de l’utilisateur doit être incluse dans l’export - Default: false @parameter include_header [boolean, optional] : Inclure ou NON le nom des colonnes dans le fichier CSV - Default: false @parameter delimiter [string, optional] : Délimiteur pour le fichier csv exporté - Default: ","
Obtenir l’historique des conditions pour un groupe spécifique
GET /audiences/v1/audience/{uuid}/conditions-history @get uuid [string, required] : L’ID de la ressource à récupérer
Obtenir un ID de groupe à partir d’un ID de public
GET /audiences/v1/audience/{uuid}/audience_to_group @get id [string, required] L’ID de la nouvelle ressource de groupe à partir de laquelle l’ancien ID de groupe est récupéré
Obtenir un ID de public à partir d’un IF de groupe
GET /audiences/v1/audience/{id}/group_to_audience @get id [integer, required] L’ID de l’ancienne ressource de groupe à partir de laquelle le nouvel ID de groupe est récupéré