Joindre le PDF imprimé au document
L'action Attach PDF (libellé non traduit) génère le PDF d'un document et l'enregistre comme pièce jointe privée de ce document. Vous retrouvez ensuite le fichier dans les pièces jointes du formulaire, sans avoir à télécharger puis à téléverser le PDF.
Prérequis
- Vous avez la permission d'imprimer et la permission d'écrire sur le document. Sans l'une des deux, l'action n'est pas proposée, et le serveur refuse la demande.
- Le document est enregistré. Depuis un formulaire modifié mais non enregistré, Dokos affiche « Save the document before attaching its PDF. » (libellé non traduit) et ne joint rien.
Joindre le PDF depuis l'aperçu d'impression
Cette méthode joint le PDF tel que l'aperçu le montre : format d'impression, en-tête de lettre (ou absence d'en-tête), langue, réglages d'impression et style.
- Ouvrez le document, puis cliquez sur Imprimer pour afficher l'aperçu d'impression.
- Choisissez le format d'impression, l'en-tête de lettre et la langue.
- Cliquez sur l'icône trombone Attach PDF (libellé non traduit), à côté de Télécharger le PDF. Sur téléphone, c'est un bouton du même nom.
- Patientez pendant le message « Attaching PDF... » (libellé non traduit).
- Une alerte verte de 10 secondes « Attached {nom du fichier} » (libellé non traduit) s'affiche. Son lien ouvre le fichier dans un nouvel onglet.
L'action est masquée pour un format d'impression brute, et pour un utilisateur qui n'a pas la permission d'écrire sur le document.
Joindre le PDF depuis le formulaire
Depuis le formulaire, le PDF est produit avec le format d'impression par défaut du type de document. S'il n'y en a pas, Dokos utilise le format Standard. Pour un autre format, passez par l'aperçu d'impression.
Vous avez deux accès :
- l'icône trombone Attach PDF (libellé non traduit), à côté de l'icône d'imprimante dans la barre latérale du formulaire ;
- l'entrée Attach PDF (libellé non traduit) du menu du formulaire. Quand la barre latérale est affichée sur grand écran, cette entrée est masquée au profit de l'icône. Elle reste disponible quand la barre latérale n'est pas affichée. Elle n'apparaît pas sur un document nouveau.
L'alerte « Attached … » s'affiche comme depuis l'aperçu, et la liste des pièces jointes de la barre latérale est rechargée.
Ce que Dokos enregistre
| Élément | Valeur |
|---|---|
| Nom du fichier | <nom du document> - <format d'impression>.pdf, par exemple SINV-0001 - Standard.pdf. |
| Visibilité | Fichier privé, attaché au document. |
| Dossier | Home/Attachments/Printed PDFs. Dokos crée ce dossier à la première utilisation. Le dossier lui-même est public, mais chaque PDF qu'il contient reste privé : seuls les utilisateurs qui peuvent lire le document voient son PDF. |
| Langue | La langue choisie dans l'aperçu. Sinon, la langue du document si celui-ci a un champ de langue, puis la langue d'impression par défaut du format. |
| Moteur PDF | Le même que Télécharger le PDF. |
Joindre à nouveau le PDF
Joindre de nouveau le PDF avec le même format met à jour le fichier que cette action avait joint auparavant : chaque format garde un seul fichier à jour, au même lien. Un autre format crée un second fichier.
Dokos remplace uniquement le plus récent des fichiers qui remplissent toutes ces conditions :
- le fichier est joint au même document ;
- le fichier est dans le dossier
Home/Attachments/Printed PDFs; - le fichier porte exactement le nom
<nom du document> - <format d'impression>.pdf; - le fichier est privé.
Les fichiers que vous avez téléversés depuis le formulaire vont dans le dossier Home/Attachments. Ils ne sont donc pas modifiés, même s'ils portent le même nom.
Si un utilisateur déplace le PDF joint vers un autre dossier, le renomme ou le rend public, ce fichier ne remplit plus ces conditions. Il reste tel quel, et l'action suivante crée un nouveau fichier dans Printed PDFs.
Documents aux pièces jointes protégées
Sur un type de document où Protéger les fichiers joints est coché, l'ancien PDF est conservé quand le document est validé. Il est aussi conservé s'il est annulé et que vous n'avez pas la permission de le supprimer. Dokos ajoute alors un nouveau fichier et l'alerte indique « The earlier PDF is protected, so it was kept. » (libellé non traduit).
Exemple fictif : la facture de vente SINV-0001 est enregistrée avec le format par défaut Standard.
- Dans le formulaire, cliquez sur le trombone à côté de l'icône d'imprimante. Le fichier privé
SINV-0001 - Standard.pdfapparaît dans les pièces jointes. - Vous corrigez le document et l'enregistrez, puis vous cliquez de nouveau sur le trombone. Le fichier existant est mis à jour au même lien.
- Vous ouvrez l'aperçu d'impression, choisissez le format « Facture détaillée » puis cliquez sur le trombone. Un second fichier,
SINV-0001 - Facture détaillée.pdf, est ajouté.
Pour les développeurs
L'action appelle la méthode frappe.utils.print_format.attach_pdf, accessible en POST et soumise à la limitation de concurrence.
| Paramètre | Rôle |
|---|---|
doctype, name | Le document à imprimer. |
format | Le format d'impression. Par défaut : le format par défaut du type de document, sinon Standard. |
no_letterhead, letterhead | Sans en-tête, ou en-tête choisi. |
language | Langue d'impression. |
pdf_generator, style, settings | Moteur PDF, style et réglages d'impression (JSON sous forme de chaîne). |
La méthode vérifie la permission d'impression, puis la permission write. Elle renvoie file_name, file_url et kept_previous (true quand l'ancien PDF protégé a été conservé).
Côté interface, frappe.ui.form.attach_pdf(doctype, name, args) appelle cette méthode, affiche l'alerte et recharge les pièces jointes du formulaire ouvert.