Documentation Frappe Framework

Frappe Framework

Notifications

L’événement peut être un document, une date, un changement de valeur ou une méthode. Le message est du Jinja. L’envoi est asynchrone.

2 min de lectureMis à jour le Source : docs.frappe.io

Rôle

Le DocType Notification prévient quand un événement se produit. Un enchaînement plus long relève d’un flux d’automatisation.

Enabled active la fiche. Channel : Email, Slack, System Notification, ou SMS (il faut SMS Settings). Is Standard, en mode développeur, marque la notification comme faisant partie d’un module standard.

Événements

Document : New, Save, Submit, Cancel.

Date : Days Before ou Days After un champ. Reference Date choisit le champ, Days Before or After le nombre de jours. Le contrôle quotidien passe par une tâche planifiée. Le bouton Get Alerts for Today sert à les essayer.

Valeur : Value Change, champ Value Changed.

Méthode : Method, et Trigger Method, par exemple before_insert ou after_update.

Custom : déclenchement programmé, sans autre détail dans la page.

Condition et destinataires

Condition est une expression Python qui doit valoir vrai. Elle voit doc, nowdate() et frappe.utils. Exemples : doc.status=="Open", doc.due_date==nowdate(), doc.total > 40000.

Pour e-mail, notification système et SMS, la table Recipients :

  • By Document Field : champ d’adresses ou de numéros ;
  • By Role : les utilisateurs du rôle ;
  • Custom : destinataires saisis.

CC et BCC pour l’e-mail. Une condition Python peut inclure un destinataire. Send to All Assignees ajoute les personnes affectées. Pour Slack, on choisit une Slack Webhook URL déjà définie.

Message

Le sujet, pour e-mail, Slack et notification système, accepte le Jinja : {{ doc.name }} Delivered. Message Type : HTML, Markdown, ou Plain Text en mode développeur seulement. Le corps est du Jinja.

Variables : {{ doc }} et ses champs, {{ comments }} (par exemple le dernier commentaire et son auteur), {% if %}...{% endif %}, {{ nowdate() }}. L’exemple publié est un avis de commande en retard : titre Order Overdue, le nom de la transaction, le dernier commentaire s’il existe, puis le client et grand_total. Le HTML publié autour de la liste est mal fermé.

Après l’envoi

Attach Print joint un PDF, avec un Print Format au choix. Attach Files : All envoie toutes les pièces du document, From Field n’envoie que From Attach Field.

Set Property After Alert met à jour un champ ensuite. Value To Be Set est la valeur écrite.

Points d’attention

Les destinataires doivent avoir le droit de voir les documents cités. L’envoi est asynchrone. Les événements de document partent au moment de l’action. Conditions et modèles sont évalués dans un environnement restreint. Si rien ne part : conditions, réglages e-mail ou SMS, URL Slack, journaux du serveur.

Notifications e-mail et Slack Frappe | ERPNext Lab