Version de développement
Cette documentation décrit la version « next » (develop), non encore publiée. Pour la version stable, basculez sur « v5 » dans l'en-tête.
Interface Utilisateur

Gérer les invitations d'utilisateurs

Inviter une personne par e-mail avec ses rôles, suivre l'invitation, la renvoyer ou l'annuler.

Gérer les invitations d'utilisateurs

Une Invitation utilisateur envoie un e-mail avec un lien. Quand la personne clique sur le lien, Dokos crée son compte utilisateur (s'il n'existe pas) avec les rôles choisis.

Prérequis

  • Vous avez le rôle Responsable système. Par défaut, seul ce rôle peut créer et consulter les invitations.
  • Le site peut envoyer des e-mails : un compte e-mail sortant est configuré.

Inviter une personne

  1. Ouvrez la recherche (Ctrl+K) et saisissez « Invitation utilisateur ».
  2. Cliquez sur le bouton d'ajout de la liste.
  3. Remplissez les champs.
  4. Enregistrez.

L'e-mail part à l'enregistrement. Le Statut passe à En cours.

ChampRôle
EmailAdresse de la personne invitée. Obligatoire.
RôlesRôles donnés au compte à l'acceptation.
Nom de l'applicationApplication à laquelle la personne est invitée. Par défaut frappe (le bureau). Obligatoire.
Rediriger vers le cheminPage ouverte après l'acceptation, par exemple /desk. Obligatoire.

Les autres champs (Statut, Invité par, Email envoyé à, Accepté le, User) se remplissent seuls.

Après l'enregistrement, seul le champ Rediriger vers le chemin reste modifiable, et seulement tant que l'invitation est En cours.

Exemple fictif : Maison Verte SARL recrute une comptable. L'administrateur crée une invitation pour comptable@maison-verte.example avec le rôle Accounts User et le chemin /desk. La comptable clique sur le lien de l'e-mail. Son compte est créé et elle arrive sur le bureau.

Suivre une invitation

StatutSignification
En coursL'e-mail est parti. La personne n'a pas encore cliqué sur le lien.
AcceptéLa personne a cliqué sur le lien. Le champ User indique son compte et Accepté le la date.
ExpiréLa personne n'a pas accepté dans les 3 jours. Une tâche quotidienne passe l'invitation à ce statut et prévient la personne par e-mail.
AnnuléUn utilisateur a annulé l'invitation.

Le délai de 3 jours n'est pas réglable.

Ce qui se passe à l'acceptation

Quand la personne clique sur le lien, Dokos :

  1. passe l'invitation au statut Accepté ;
  2. crée un utilisateur système si l'adresse n'a pas encore de compte, sans e-mail de bienvenue ;
  3. ajoute les rôles de l'invitation au compte ;
  4. ouvre la page Rediriger vers le chemin.

Renvoyer ou annuler une invitation

Sur une invitation En cours, deux boutons s'affichent :

  • Renvoyer : envoie de nouveau l'e-mail. Dokos affiche « Invitation renvoyée ».
  • Annuler : passe l'invitation au statut Annulé. Le lien ne fonctionne plus. La personne invitée reçoit un e-mail.

Si l'invitation a expiré, créez-en une nouvelle.

Limites

  • Une même adresse ne peut pas avoir deux invitations en cours pour la même application.
  • Vous ne pouvez pas inviter de nouveau une adresse qui a déjà accepté une invitation pour la même application.
  • Vous ne pouvez pas inviter l'adresse d'un utilisateur désactivé.
  • Pour une autre application que frappe, seuls les rôles déclarés par l'application sont acceptés.

Applications qui utilisent les invitations

Parmi les applications utilisables avec Dokos, seule Helpdesk déclare ses propres invitations :

Rôle qui inviteRôles qu'il peut donner
Agent ManagerAgent, Agent Manager, HD Customer, HD Customer Manager
System ManagerAgent, Agent Manager, System Manager, HD Customer, HD Customer Manager

Une invitation Helpdesk peut aussi porter le client et le contact de la personne invitée. Les autres applications (Dokos, Frappe CRM, Gameplan, Frappe Learning…) ne déclarent pas d'invitations : utilisez celles de frappe.

Pour les développeurs

Une application déclare ses invitations dans le hook user_invitation de son hooks.py :

  • allowed_roles : pour chaque rôle qui invite, la liste des rôles qu'il peut donner.
  • after_accept : fonctions appelées après l'acceptation, avec invitation, user et user_inserted.
  • extra_invite_params : noms de paramètres supplémentaires acceptés par invite_by_email et enregistrés sur l'invitation (Helpdesk : customer et contact).

Les méthodes invite_by_email, get_pending_invitations, cancel_invitation et resend_invitation sont dans frappe/core/api/user_invitation.py.

Une interface Vue peut utiliser le composant InviteUser (@framework/ui/components/InviteUser) avec le contrôleur useInviteUser(). Le composant affiche un champ multi-adresses avec suggestion des utilisateurs existants, un choix de rôles et un bouton d'envoi. Il n'affiche pas la liste des invitations en cours.