Documentation en ligne

Envoyer une invitation ics par courriel

Lors d’une démarche, l’usager a pris rendez-vous avec la collectivité (utilisation de l’agenda). Vous souhaitez qu’il puisse ajouter ce rendez-vous à son agenda personnel.

Pour permettre une meilleure compréhension, le formulaire et le workflow ont été simplifiés et sont incomplets : le formulaire contient les informations minimales pour fonctionner, et le workflow ne gère pas le circuit complet (annulation, déplacement de rendez-vous, etc).

On y va

Téléchargez les objets nécessaires :

État initial

L’usager prend un rendez-vous. Le rendez-vous s’affiche dans l’agenda en back-office. Un courriel est envoyé à l’usager avec les informations du rendez-vous dans le corps du message.

Explications

Dans l’agenda de l’agent, en back-office, le créneau sera réservé avec les informations label et user_name (forme : label – user_name). Le lien sur l’intitulé est généré grâce à backoffice_url.

Modifications à apporter

  1. Le fichier ICS généré est une donnée de traitement, on crée donc une nouvelle donnée de traitement de type fichier :
    • nom : par exemple « Fichier ics »
    • type : fichier
    • identifiant : par exemple « fichierics » ({{ form_var_fichierics }})
  1. On génère l’ics à partir du statut « Enregistrement du RDV ». Pour cela, on ajoute une action « webservice » :
    • Nom : génération ics

    • url : {{reservation_response_api_ics_url}} ; quelques explications :

      • reservation est l’identifiant de l’appel webservice de l’agenda ; peut varier selon les workflows

      • response est le retour de l’appel au webservice (ce nom est statique et ne change jamais)

      • api_ics_url est le nom de la donnée générée par le webservice ; ce nom ne change jamais

    • Données à envoyer en paramètres de l'URL :

      • comment : il s’agit d’un commentaire à propos du rendez-vous. Le champ commentaire n’est pas affiché par tous les agendas, n’indiquez rien d’important dans ce champ (utilisez le champ description pour cela).

      • description : c’est la description du rendez-vous. Indiquez par exemple « rendez-vous en mairie pour votre renouvellement de passeport »

      • location : indiquer ici le lieu du rendez-vous (par exemple : Mairie de Fondcomb). Si vous indiquez une adresse précise, certains logiciels de messagerie proposent le lien vers une carte.

      • url : lien vers la démarche par exemple ({{form_url}})

      • tous les paramètres ci-dessus sont facultatifs, mais nous recommandons de renseigner au moins description et location.

    • Type de réponse : choisissez « fichier joint »
    • Identifiant : indiquez un identifiant, par exemple : « ics ». Cet identifiant sera utilisé comme nom de fichier (par exemple si l’identifiant est « fichier_ics », le fichier joint se nommera fichier_ics.ics)
    • Enregistrez dans les données de traitement : choisissez la donnée de traitement nouvellement créée, dans notre exemple « Fichier ics »
  1. Joignez l’ics généré au courriel :

    • allez dans l’action « courriel » dans le statut « rendez-vous réservé ». Sous le corps du message, « Fichiers attachés », choisissez la donnée de traitement concernée, par exemple « Fichier ics ».

  1. Testez !

    1. Remplissez la démarche avec une adresse courriel existante

    2. le courriel reçu contient l’invitation :

      invitation ics

    3. affichage du rendez-vous dans l’agenda :

      affichage du rendez-vous dans l'agenda

Le titre du rendez-vous (title, ou summary) reprend par défaut la valeur du champ « label » paramétré lors de l’appel précédent au webservice (voir section suivante pour modifier cela). Le nom de la personne qui a rendez-vous (« attendee ») utilise, lui, la valeur du champ « user_name ».

Aller plus loin : changer le titre du rendez-vous dans l’invitation

Il peut être intéressant d’avoir un intitulé différent pour l’agent en back-office et pour l’usager dans son agenda.

Pour personnaliser le nom de l’événement pour l’usager, on utilise le paramètre « user_display_label » :

  1. dans le statut « Enregistrement du RDV », allez dans la première action « webservice », nommée dans l’exemple « Réservation ».
  2. dans les données à envoyer dans le corps de la requête, ajoutez le paramètre « user_display_label » et indiquez comme valeur le nom de l’événement pour l’usager, le titre qu’il verra apparaître dans son agenda. Par exemple : « rendez-vous Mairie pour passeport »
  3. testez !

Invitation ics personnalisée

affichage dans l'agenda : titre personnalisé

Conclusion

Téléchargez le workflow modifié : howto_01-ics_workflow_final.wcs

Vous pouvez retrouver la documentation complète de l'agenda ici.

Dernière mise à jour le 12 août 2019 14:59 — Éditer