Zum Hauptinhalt springen

Dokument mithilfe einer Vorlage in Make erstellen

Dokument mithilfe einer Vorlage erstellen ist ein PDF4me-Modul für Make, das eine gespeicherte Vorlage aus Ihrem PDF4me-Repository mit JSON, XML oder CSV Die Daten werden verarbeitet und ein fertiges Dokument zurückgegeben. Wählen Sie die Vorlage anhand des Namens, ordnen Sie Ihre Daten direkt oder als Datei zu und generieren Sie Rechnungen, Verträge und Briefe, ohne bei jedem Durchlauf eine Vorlagendatei hochladen zu müssen.

Was dieses Modul bewirkt

PDF4me: Dokument mithilfe einer Vorlage erstellen Erzeugt ein Dokument, indem eine in Ihrem PDF4me-Repository gespeicherte Vorlage mit von Ihnen als JSON, XML oder CSV bereitgestellten Daten zusammengeführt wird. Im Gegensatz zu dateibasierten Generierungsmodulen wählen Sie die Vorlage anhand ihres Namens aus einem Dropdown-Menü aus; ein Upload oder eine Zuordnung der Vorlage ist nicht erforderlich. Daten können direkt im Dokument bereitgestellt werden. Dokumentdaten-Text oder als zugeordnete Datei über Dokumentdatendatei, fügen Sie optionale Feldformatierungen hinzu mit Metadaten JSONund leite das generierte Dokument an Upload File, Send Email oder ein beliebiges nachfolgendes Make-Modul weiter.

Verwandte Blog-Beiträge
Zu dieser Funktion gibt es noch keinen Blogbeitrag – folgt in Kürze.
Schauen Sie sich in der Zwischenzeit im PDF4me-Blog Tutorials und Arbeitsabläufe für alle Plattformen an.
Besuchen Sie den Blog →

Authentifizierung Ihrer API-Anfrage​

Jedes PDF4me-Modul in Make benötigt eine gültige VerbindungErstellen oder wählen Sie einen Eintrag aus, der Ihren PDF4me-API-Schlüssel enthält, damit das Szenario Dokumentengenerierungsanfragen sicher authentifizieren kann.

Wichtige Fakten, die Sie nicht verpassen sollten​

Der Vorlagenname ist eine Repository-Vorlage, keine Datei.
Der Vorlagenname Die Dropdown-Liste zeigt die in Ihrem PDF4me-Repository gespeicherten Vorlagen an. Sie wählen eine gespeicherte Vorlage anhand ihres Namens aus, anstatt eine Vorlagendatei hochzuladen oder zuzuordnen. klicken Sie hier Über den Link neben dem Feld gelangen Sie zum Repository, wo Sie eine Vorlage erstellen oder bearbeiten können.
Unterstützt JSON-, XML- und CSV-Daten
Satz Dokumentdatentyp Für Objekte oder Arrays wird das Format JSON, für XML-Dokumente das Format XML und für durch Kommas getrennte Zeilen das Format CSV gewählt. Das gewählte Format gilt unabhängig von der verwendeten Datenquelle: Dokumentdaten-Text oder Dokumentdatendatei.
Bitte geben Sie entweder einen Datentext oder eine Datendatei an.
Sie können Ihre Daten auf eine der folgenden zwei Arten bereitstellen: durch Einfügen oder Inline-Zuordnung. Dokumentdaten-Text (gut geeignet für CRM-Felder und kleine Datenmengen) oder eine Binärdatei abbilden in Dokumentdatendatei (Gut geeignet für größere oder extern verwaltete Datenmengen). Sie benötigen nicht beides.
Das Modul „PDF4me Dokument mithilfe einer Vorlage generieren“ zeigt an, dass die Verbindung auf „Meine PDF4me-Verbindung“ eingestellt ist, der Vorlagenname auf eine aus dem PDF4me-Repository ausgewählte Beispielvorlage, der Dokumentdatentyp auf JSON eingestellt ist, der Dokumentdatentext ein vier Felder großes JSON-Objekt enthält und die Felder „Dokumentdatendatei“ und „Metadaten-JSON“ leer sind.

Wählen Sie eine gespeicherte Vorlage aus in Vorlagenname, Satz Dokumentdatentypund Daten liefern über Dokumentdaten-Text oder DokumentdatendateiPflichtfelder sind mit einem roten Sternchen gekennzeichnet.

Woher stammen die Vorlagen?​

Der Vorlagenname Das Dropdown-Menü wird aus den folgenden Daten befüllt: Dokumentvorlage Bereich des PDF4me-Dashboards. Vorlagen werden in Ihrem Konto gespeichert, nicht im Erstellungsszenario. Sie erstellen also eine Vorlage einmal und können sie in jedem Szenario, Ablauf und API-Aufruf wiederverwenden.

Die PDF4me-Dashboard-Seite „Dokumentvorlage“ listet drei gespeicherte Vorlagen in einer Tabelle mit den Spalten „Vorlagenname“, „Vorlagentyp“, „Ausgabedateityp“ und „Aktionen“ auf: Benutzerformular (PDF-Formular, das eine PDF-Datei erzeugt), Tagesbericht (HTML-Vorlage, die eine HTML-Datei erzeugt) und Rechnungsvorlage (PDF4me-Word-Vorlage, die eine PDF-Datei erzeugt). Über der Tabelle befindet sich eine Schaltfläche „Hinzufügen“ sowie Bearbeitungs- und Löschsymbole pro Zeile.

Jede Vorlage, die Sie hier speichern, erscheint in der Vorlagenname Dropdown-Menü unter „Erstellen“. Klicken Sie darauf. Hinzufügen Um eine Vorlage zu erstellen, oder über das Stiftsymbol, um eine bestehende Vorlage zu bearbeiten.

Jede Zeile in dieser Tabelle entspricht einem Eintrag im Dropdown-Menü „Herstellen“:

SpalteWas bedeutet das in Make
VorlagennameDer genaue Text, den Sie auswählen unter VorlagennameGeben Sie den Vorlagen eindeutige Namen, damit die Dropdown-Liste auch bei großem Umfang lesbar bleibt.
VorlagentypDas Quellformat, in dem Sie die Vorlage erstellt haben, zum Beispiel PDF Form, HTML, oder PDF4me WordDies ist in der Vorlage festgelegt, daher fragt Make Sie nie danach.
AusgabedateitypDas Format, in dem das generierte Dokument zurückgegeben wird, zum Beispiel PDF oder HTMLDie
AktionenBearbeiten oder löschen Sie die Vorlage. Durch das Umbenennen einer Vorlage ändert sich der Wert im Dropdown-Menü „Erstellen“. Aktualisieren Sie daher alle Szenarien, die auf den alten Namen verweisen.
Deshalb besitzt das Modul kein Feld für den Ausgabetyp.

Sowohl das Vorlagenformat als auch das Ausgabeformat werden hier, in der Vorlage selbst, festgelegt. Dokument mithilfe einer Vorlage erstellen Es werden lediglich ein Vorlagenname und Ihre Daten abgefragt. Falls Sie denselben Inhalt in einem anderen Ausgabeformat benötigen, speichern Sie eine zweite Vorlage mit einem anderen Vorlagennamen. AusgabedateitypDie

:::Vorsicht beim Umbenennen! Das Modul speichert die Vorlage. NameEs handelt sich nicht um eine ID. Wenn Sie eine Vorlage im Dashboard umbenennen, schlägt jedes Make-Szenario, das noch auf den alten Namen verweist, fehl, bis Sie es erneut auswählen. Verwenden Sie die Karte Einschalten Vorlagennamefalls Sie den Namen stattdessen dynamisch übergeben müssen. :::

Welche Parameter verwendet die Funktion „Dokument mithilfe einer Vorlage generieren“ in Make?​

Erforderlich: Verbindung, Vorlagenname und Dokumentdatentyp. Bedingt: Dokumentdatentext ODER Dokumentdatendatei (eine der beiden Dateien muss die Nutzdaten enthalten). Optional: Metadaten im JSON-Format. Informationen zu Datenformatstandards finden Sie unter [Link einfügen]. RFC 4180 für CSV und die offizielle JSON-SpezifikationDie

ParameterErforderlichWas es tutBeispiel
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":[...]}

Ausgabe​

Das Modul gibt pro Durchlauf ein Bundle zurück, das das generierte Dokument enthält und für nachfolgende Make-Module bereit ist.

FeldTypWas es enthält
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.

Wie richte ich in Make die Option „Dokument mithilfe einer Vorlage generieren“ ein?​

  1. Hinzufügen PDF4me und auswählen Dokument mithilfe einer Vorlage erstellenDie
  2. Wählen Verbindung (oder klicken Sie hier) Hinzufügen (um einen mit Ihrem API-Schlüssel zu erstellen).
  3. Öffne die Vorlagenname Öffnen Sie das Dropdown-Menü und wählen Sie eine gespeicherte Vorlage aus Ihrem PDF4me-Repository aus. Falls die Liste leer ist, erstellen Sie zuerst eine unter Dokumentvorlage im Dashboard oder verwenden Sie die klicken Sie hier Link neben dem Feld.
  4. Satz Dokumentdatentyp Zu JSON, XML, oder CSV-Datei um Ihre Daten abzugleichen.
  5. Geben Sie die Daten ein: Fügen Sie sie ein oder ordnen Sie sie zu in Dokumentdaten-Textoder eine Datendatei zuordnen in DokumentdatendateiDie
  6. Optional hinzufügen Metadaten JSON für Datums-, Kontrollkästchen- oder HTML-Feldformatierung.
  7. Klicken Speichern und ausführen. Ordnen Sie die generierten Daten zu. Dokumentdaten Ausgabe in ein Modul zum Hochladen von Dateien, zum Versenden von E-Mails oder zum Archivieren.

Workflow-Beispiele​

Workflow-BeispieleCommon Make scenario patterns using Generate Document Using Template.
CRM-Deal in Rechnung stellen aus einer gespeicherten Vorlage
  1. Ein CRM-Webhook wird ausgelöst, wenn ein Deal abgeschlossen wird.
  2. Mit der Funktion „Dokument anhand einer Vorlage generieren“ wird die gespeicherte Rechnungsvorlage ausgewählt und die Deal-Felder als JSON-Daten im Dokumentdatentext eingelesen.
  3. Die erstellte Rechnung wird dem Kunden per E-Mail zugesandt und im Auftragsdatensatz gespeichert.
CSV-Export in Stapelverarbeitungsbriefe
  1. Ein geplanter Auslöser lädt eine CSV-Exportdatei aus dem Cloud-Speicher herunter.
  2. Der Dokumentdatentyp ist auf CSV eingestellt und die Datei ist der Dokumentdatendatei zugeordnet.
  3. Die gespeicherte Briefvorlage wird zusammengeführt und jedes generierte Dokument wird in einem datierten Ordner archiviert.
Formatierter Vertrag mit Metadaten (JSON)
  1. Durch das Absenden eines Formulars werden Vertragsdaten im JSON-Format übermittelt.
  2. Die Metadaten-JSON-Datei legt das Feld für das Gültigkeitsdatum während des Zusammenführens auf das Format JJJJMMTT fest.
  3. Die gespeicherte Vertragsvorlage wird generiert und zur elektronischen Signatur weitergeleitet.

Häufig gestellte Fragen​

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.

Ähnliche Aktionen​

Hilfe erhalten​