Administration
Um ein PDF zu generieren und Templates zu verwalten, muss deinem Benutzer eine Rolle zugewiesen sein, die das Berechtigungsobjekt „Plugin PDF-Generierung“ enthält.
Templates
Du kannst ein PDF-Template mit HTML, CSS und JSON erstellen. Eine Live-Vorschau wird rechts angezeigt, sodass du Änderungen in Echtzeit sehen kannst.
Das Rendering wird mit wkhtmltopdf ausgeführt, daher funktionieren alle HTML-Formate und -Funktionen, die die QT Webkit Render-Engine unterstützen.
Mit jedem Template wird ein Stylesheet im LESS-Format generiert und automatisch eingebettet. Du kannst dieses Stylesheet über dieselbe Oberfläche wie das HTML-Template pflegen.
Die Einbindung von Grafiken (<img src=”…”>) und zusätzlichen Stylesheets (<link rel=”stylesheet” href=”…”>) wird ebenfalls unterstützt.
Diese externen Assets werden über den „assets“-Slot des AppServers abgerufen (sie sollten dort vorab hochgeladen werden). Du kannst in der Vorlage mit einem relativen Dateinamen auf sie verweisen (kein „http://“-Präfix, kein Pfad usw.!).
Beispiel: <img src=”image.jpg”> (wenn die Datei als „image.jpg“ hochgeladen wurde)
Des Weiteren kannst du Ausdrücke im Mustache-Format hinzufügen. Diese „Variablen“ werden später durch Werte aus der Update-Datei einer Session ersetzt.
Die dynamischen Daten werden als JSON-String im Key-Value-Store mit dem Schlüssel: „sessiondata/$session“ abgerufen.
($session = die Session-ID, die für die Generierung angegeben wird)
Zusammenführen
Du kannst dein PDF-Dokument mit anderen PDFs oder Bildern aus dem Key-Value-Store kombinieren.
Dazu kannst du die Liste aller Ressourcen, die du zusammenführen möchtest, mit dem Schlüssel „merge/$session“ im Key-Value-Store abrufen. Die Liste sollte einem JSON-Array entsprechen, wobei die Einträge des JSON-Arrays die Schlüssel der zusammenzuführenden Ressourcen sind. Zum Beispiel: [“document1.pdf”, “document2.pdf”, “image.jpg”].
Die Binärdaten der entsprechenden Dokumente sollten im Key-Value-Store unter den Schlüsseln „document2.pdf“, „document2.pdf“ und „image.jpg“ abgelegt werden.
Wenn die Liste der zusammenzuführenden Ressourcen für eine Session nicht gefunden wird oder wenn die Liste leer ist, wird das Zusammenführen übersprungen.
Speichern des generierten PDFs
Nachdem ein PDF erfolgreich generiert wurde, werden die Binärdaten im Key-Value-Store unter dem Schlüssel „pdf/$jobid.pdf“ gespeichert. ($jobid = die Job-ID, die nach dem Start der Generierung zurückgegeben wird)
Wenn die Generierung aufgrund eines Fehlers nicht erfolgreich ausgeführt werden kann, wird eine Fehlermeldung unter dem Schlüssel „pdf/$jobid.log“ im Key-Value-Store gespeichert.
