Aller au contenu principal

Générer un document à partir d'un modèle dans Make

Générer un document à partir d'un modèle est un module PDF4me pour Make qui fusionne un modèle enregistré depuis votre dépôt PDF4me avec JSON, XML ou CSV Utilisez des données et obtenez un document finalisé. Choisissez le modèle par son nom, intégrez vos données directement ou via un fichier, et générez des factures, des contrats et des lettres sans avoir à importer un fichier modèle à chaque exécution.

Que fait ce module ?

PDF4me Générer un document à partir d'un modèle Génère un document en fusionnant un modèle stocké dans votre référentiel PDF4me avec les données que vous fournissez au format JSON, XML ou CSV. Contrairement aux modules de génération basés sur des fichiers, vous sélectionnez le modèle par son nom dans une liste déroulante ; aucun téléchargement ni mappage de modèle n’est requis. Fournissez des données directement dans le document via Texte des données du document ou sous forme de fichier mappé via fichier de données du document, ajoutez une mise en forme de champ facultative avec Métadonnées JSONet rediriger le document généré vers Upload File, Send Email ou tout autre module Make en aval.

Articles de blog connexes
Il n'y a pas encore d'article de blog consacré à cette fonctionnalité — à venir prochainement.
En attendant, n'hésitez pas à consulter le blog de PDF4me pour découvrir des tutoriels et des procédures de travail adaptés à toutes les plateformes.
Consultez le blog →

Authentification de votre requête API​

Chaque module PDF4me dans Make nécessite un fichier PDF4me valide ConnexionCréez ou sélectionnez un scénario contenant votre clé API PDF4me afin que le système puisse authentifier en toute sécurité les demandes de génération de documents.

Informations importantes à ne pas manquer​

Le nom du modèle est un modèle de dépôt, et non un fichier.
Le Nom du modèle La liste déroulante affiche les modèles enregistrés dans votre répertoire PDF4me. Vous sélectionnez un modèle enregistré par son nom au lieu de télécharger ou d'associer un fichier modèle. Utilisez la Cliquez ici Cliquez sur le lien situé à côté du champ pour ouvrir le référentiel et créer ou modifier un modèle.
Prend en charge les données JSON, XML et CSV
Ensemble Type de données du document Le format choisi est JSON pour un objet ou un tableau, XML pour les documents XML et CSV pour les lignes séparées par des virgules. Ce format s'applique quelle que soit la source utilisée : texte ou fichier de données.
Fournissez soit du texte de données, soit un fichier de données.
Fournissez vos données de deux manières : collez-les ou intégrez-les directement dans le flux. Texte des données du document (idéal pour les champs CRM et les petites charges utiles), ou mapper un fichier de données binaires en fichier de données du document (Idéal pour les données volumineuses ou gérées en externe). Vous n'avez pas besoin des deux.
Le module « Générer un document à partir d'un modèle » de PDF4me affiche la connexion définie sur « Ma connexion PDF4me », le nom du modèle défini sur « Modèle d'exemple sélectionné dans le référentiel PDF4me », le type de données du document défini sur JSON, le texte des données du document contenant un objet JSON à quatre champs, et les champs « Fichier de données du document » et « Métadonnées JSON » vides.

Choisissez un modèle enregistré dans Nom du modèle, ensemble Type de données du documentet fournir des données via Texte des données du document ou fichier de données du documentLes champs obligatoires sont marqués d'un astérisque rouge.

D'où viennent les modèles ?​

Le Nom du modèle La liste déroulante est alimentée par le Modèle de document Cette zone du tableau de bord PDF4me contient des modèles stockés dans votre compte, et non dans le scénario de création. Vous pouvez donc en créer un une seule fois et le réutiliser pour chaque scénario, flux et appel d'API.

La page « Modèles de documents » du tableau de bord PDF4me affiche trois modèles enregistrés dans un tableau avec les colonnes « Nom du modèle », « Type de modèle », « Type de fichier de sortie » et « Actions » : Formulaire utilisateur (au format PDF), Rapport quotidien (au format HTML) et Modèle de facture Word (au format PDF4me). Un bouton « Ajouter » est situé au-dessus du tableau, et des icônes « Modifier » et « Supprimer » sont présentes sur chaque ligne.

Chaque modèle que vous enregistrez ici apparaît dans le Nom du modèle menu déroulant dans Make. Cliquez Ajouter pour en créer un, ou l'icône en forme de crayon pour modifier un modèle existant.

Chaque ligne de ce tableau correspond à une entrée de la liste déroulante Make :

ColonneCe que cela signifie dans Make
Nom du modèleLe texte exact que vous sélectionnez sous Nom du modèleAttribuez des noms distincts aux modèles afin que le menu déroulant reste lisible quelle que soit sa taille.
Type de modèleLe format source dans lequel vous avez créé le modèle, par exemple PDF Form, HTML, ou PDF4me WordCela est intégré au modèle, donc Make ne vous le demandera jamais.
Type de fichier de sortieLe format du document généré est par exemple : PDF ou HTML.
ActesModifiez ou supprimez le modèle. Renommer un modèle modifie la valeur affichée dans la liste déroulante « Créer », mettez donc à jour tout scénario qui faisait référence à l’ancien nom.
C'est pourquoi le module ne comporte pas de champ Type de sortie.

Le format du modèle et le format de sortie sont définis ici, dans le modèle lui-même. C'est pourquoi Générer un document à partir d'un modèle Il vous suffit d'indiquer le nom du modèle et vos données. Si vous souhaitez exporter le même contenu dans un format différent, enregistrez un deuxième modèle avec un nom différent. Type de fichier de sortie.

Attention : renommez avec précaution.

Le module stocke le modèle. nomIl ne s'agit pas d'un identifiant. Si vous renommez un modèle dans le tableau de bord, tout scénario Make pointant encore vers l'ancien nom échouera jusqu'à ce que vous le resélectionniez. Utilisez la Carte activer Nom du modèlesi vous devez transmettre le nom de manière dynamique. :::

Quels paramètres utilise la fonction « Générer un document à partir d'un modèle » dans Make ?​

Requis: Connexion, nom du modèle et type de données du document. Conditionnel: Données textuelles du document OU fichier de données du document (l'un des deux doit contenir la charge utile des données). Facultatif: Métadonnées JSON. Pour les normes de format de données, voir RFC 4180 pour CSV et le Spécification JSON officielle.

ParamètreRequisCe que cela faitExemple
ConnectionRequiredPDF4me connection for the scenario. Click Add to create one with your API key, or select an existing connection.My PDF4me connection
Template nameRequiredDocument template chosen from your PDF4me repository. Pick a saved template from the dropdown. Use the click here link to open the repository and create a new template. Has a Map toggle for dynamic selection.sample template
Document data typeRequiredFormat of the data payload. JSON for object/array, XML for XML documents, CSV for comma-separated rows. Has a Map toggle.JSON
Document data textConditionalMap the fields from a CRM or prior steps as JSON, XML, or CSV text. Use this field when you are not uploading a data file.{ "name": "John" }
Document data fileConditionalMap a file containing the document data in JSON, XML, or CSV format. Use this instead of Document data text when the data comes from a download or upload module.2. Data
Metadata JSONNoOptional JSON that controls field formatting during the merge, for example date formats or checkbox and HTML field types. Leave empty for plain text substitution.{"FieldsMetaData":[...]}

Sortir​

Le module renvoie un seul paquet par exécution contenant le document généré, prêt pour les modules Make en aval.

ChampTaperCe qu'il contient
DocumentFile (binary data)Content (binary data) of the resulting generated document, returned on docData. Map it together with File Name into the next module, for example Upload a File or Send Email Attachment.
File NameFile nameFile name of the resulting generated document, returned on name. Map it together with Document into the next module, for example to upload or email the file.

Comment configurer la génération de documents à partir d'un modèle dans Make ?​

  1. Ajouter PDF4me et sélectionnez Générer un document à partir d'un modèle.
  2. Sélectionner Connexion (ou cliquez Ajouter pour en créer une avec votre clé API).
  3. Ouvrez le Nom du modèle Dans le menu déroulant, sélectionnez un modèle enregistré dans votre répertoire PDF4me. Si la liste est vide, créez-en un au préalable. Modèle de document dans le tableau de bord, ou utilisez le Cliquez ici lien à côté du champ.
  4. Ensemble Type de données du document à Json, XML, ou CSV pour correspondre à vos données.
  5. Fournissez les données : collez-les ou mappez-les dans Texte des données du document, ou mapper un fichier de données dans fichier de données du document.
  6. Ajouter éventuellement Métadonnées JSON pour la mise en forme des dates, des cases à cocher ou des champs HTML.
  7. Cliquez Sauvegarder et exécuter. Cartographier le généré Données du document Générer un fichier à télécharger, un e-mail à envoyer ou un module d'archivage.

Exemples de flux de travail​

Exemples de flux de travailCommon Make scenario patterns using Generate Document Using Template.
Générer une transaction CRM à facturer à partir d'un modèle enregistré
  1. Un webhook CRM se déclenche lorsqu'une transaction est conclue.
  2. L'option « Générer un document à partir d'un modèle » sélectionne le modèle de facture enregistré et lit les champs de la transaction au format JSON dans le texte des données du document.
  3. La facture générée est envoyée par courriel au client et enregistrée dans le dossier de la transaction.
Exportation CSV vers des lettres par lots
  1. Un déclencheur programmé télécharge un fichier CSV exporté depuis le stockage cloud.
  2. Le type de données du document est défini sur Csv et le fichier est mappé dans le fichier de données du document.
  3. Le modèle de lettre enregistré est fusionné et chaque document généré est archivé dans un dossier daté.
Contrat formaté avec métadonnées JSON
  1. La soumission d'un formulaire fournit les données contractuelles au format JSON.
  2. Les métadonnées JSON définissent le champ de date d'effet au format aaaaMMj lors de la fusion.
  3. Le modèle de contrat enregistré est généré et acheminé pour signature électronique.

Foire aux questions​

How is Template name different from the file-based generate modules?+
In Generate Document Using Template, Template name is a dropdown that lists the templates saved in your PDF4me repository. You select a stored template by name instead of uploading or mapping a template file, so no File Type or Output Type fields are needed. Create or edit templates from the PDF4me dashboard.
What data formats can I supply?+
Document data type accepts Json for an object or array, Xml for XML documents, or Csv for comma-separated rows. Choose the format that matches your source data, then supply it via Document data text or Document data file.
Should I use Document data text or Document data file?+
Provide one of the two. Use Document data text to paste or map data inline from a CRM or a prior module. Use Document data file to map a binary data file. The file option is best for larger or externally maintained payloads.
What is Metadata JSON used for?+
Metadata JSON is optional and controls how specific template fields are formatted during the merge, for example date formats or checkbox and HTML field types. Leave it empty for plain text substitution.
How do I create a template for this module?+
Create it in the Document Template area of the PDF4me dashboard at https://dev.pdf4me.com/dashboard/#/document-template/ . Click Add, choose the Template Type (PDF Form, HTML, or PDF4me Word) and the Output File Type, then save. The template then appears in the Template name dropdown in Make. The click here link next to the field opens the same page.

Actions connexes​

Obtenez de l'aide​