Inhalt

Das kostenpflichtige Plugin Print-Service ermöglicht es, im Workflow ein PDF aus dem Formular zu erzeugen, welches für den Druck geeignet ist.

Technische Besonderheiten

Um das Print-Service Plugin verwenden zu können, ist es erforderlich den Print Server zu installieren. Dieser kann auf dem gleichen Server wie der FORMCYCLE Master-Server installiert werden.

Installationsanleitung Print Server

Kompatibilität von Print-Service-Plugin und Print-Server 

Von der grundsätzlichen Funktionalität her sind verschiedene Versionen des Print-Service-Plugins praktisch mit allen Print-Server-Versionen kompatibel. Spezielle Features des Plugins werden jedoch erst mit neueren Print-Server-Versionen unterstützt.

Wir verwenden für die Versionsnummern des Print-Servers Semantic Versioning, sodass sich aus den ersten beiden Ziffern der Versionsnummer eine Kompatibilität ableiten lässt. Ein Print-Server mit der Version 2.0.0 ist dementsprechend im Bezug auf Features und der Kompatibilität identisch zu einem Print-Server mit der Version 2.0.4.

Einrichtung des Plugins

Installation Plugin Print-Service

Damit das Plugin in FORMCYCLE als Aktion im Workflow zur Verfügung steht, muss dieses im Bereich Systemplugin der Verwaltungsoberfläche bereitgestellt werden. Eine Anleitung zur Installation von Plugins finden Sie hier.

Konfiguration des Plugins

Nachdem das Plugin installiert wurde, muss noch die Service-URL angepasst werden. Diese wird am Plugin über den Pflichtparameter pdf.print.services.url festgelegt.

Ist die Installation auf dem gleichen Server wie FORMCYCLE erfolgt, dann ist als Domain localhost anzugeben. Wurden keine Änderungen an dem Port vorgenommen, so bleibt die Einstellung 8090 beibehalten.
Zum Beispiel: http://localhost:8089/pdf

Damit ist die Einrichtung des Print-Service Plugins abgeschlossen und steht als Aktion im Workflow zur Verfügung.

Log-Dateien zum Plugin

Unter Windows werden die Log-Dateien im daemon Ordner abgelegt. Wenn das Installationsverzeichnis bei Installation nicht geändert wurde, dann befinden sich die Dateien unter C:\Programme\print_server_fc\daemon. Im Fehlerfall sind die Dateien formcycleprintserver.out.log und formcycleprintserver.err.log relevant.

Unter Linux wird die Log-Datei direkt im Print-Server Verzeichnis angelegt, z.B. /home/BENUTZERNAME/print_server/printserver.log.

Optionen der Plugin-Aktion

Um das Plugin zu nutzen, klicken Sie im Workflow auf neue Aktion und wählen das Print-Plugin aus. Die folgenden Optionen werden zum Konfigurieren der Plugin-Aktion verwendet:

Druck-Modus

Formularfelder in Text umwandeln

Eingabefelder werden in Text umgewandelt und das Formular wird in der Breite entsprechend angepasst, siehe nächster Abschnitt.

Formularfelder bewahren

Das Formular wird so in dem PDF ausgegeben wie es auch im Browser aussieht.

Papiergröße

Angabe des Formats für das gedruckte Dokument.

Zu druckende Seiten

Namen der Seiten, die gedruckt werden sollen, getrennt mit Komma. Wenn leer, werden alle Seiten gedrückt. Beispiel: p1, p3, p5 druckt nur die Seiten mit Namen "p1", "p3" und "p5".

Seitenausrichtung

Seiteausrichtung, welche für den Druck verwendet werden soll, Quer- und Hochformat sind möglich.

Hintergrundbilder und Farben berücksichtigen

Hintergrundbilder und Farben werden nicht immer mit berücksichtigt, dies kann hiermit erzwungen werden.

Blankodruck

(erfordert wenigstens Print-Plugin ab Version 4.2.0 und Print-Service ab Version 1.4.0) Wenn aktiviert, werden beim Druck alle Formularfelder geleert, alle versteckten Felder angezeigt. Zudem werden einige weitere Anpassungen für Blankodrücke vorgenommen, etwa wird die maximale Anzahl an Elementwiederholungen erzeugt.

Formulartitel in der Kopfzeile anzeigen

Titel des Formulars im Kopfbereich des Dokumentes mitdrucken.

Seitenzahlen in der Fußzeile anzeigen

Seitanzahl in des Fußzeile des Dokumentes mitdrucken.

Datum in der Kopfzeile anzeigen

Aktuelle Daum im Kopfbereich des Dokumentes mitdrucken.

Zoomfaktor

Faktor, um den das Formular vergrößert wird. Ist dieser kleiner 1, wird das Formular verkleinert. Kann genutzt werden, um besonders große oder kleine Formulare auf das A4-Format des PDF-Dokuments anzupassen.

Rand

Einstellungen für den Rand für oben, links, rechts und unten in Millimeter.

Status beim Drucken

In Abhängigkeit von einem bestimmten Status drucken. Durch die Einstellungsmöglichkeit Verfügbar wenn, können Formularelemente abhängig vom Status ausgeblendet werden und somit kann das Druckbild beeinflusst werden.

Benutzergruppen

Benutzergruppen, denen der virtuelle Benutzer angehört, der das Formular über Selenium öffnet. Formularelemente können abhängig von der Benutzergruppe ausgeblendet bzw. readonly geschaltet werden.

URL-Parameter

Zusätzliche URL-Parameter, die an die URL angehängt werden, wenn das Formular über Selenium bei der Generierung des PDF-Dokuments geöffnet wird. Diese können beispielsweise genutzt werden, um Formularfelder vorzubefüllen. Auf diese URL-Parameter kann auch von selbstgeschriebenem JavaScript im Scriptbereich zugegriffen werden.

Timeout (in Sekunden)

Timout, bis der Druck abgebrochen wird, weil z.b. der Dienst nicht erreichbar ist. Die Standardeinstellung von 30 Sekunden zu ändern, kann dann sinnvoll sein, wenn die Last für den Druckprozessor erhöht ist um alle Anfragen abzuarbeiten.

Zeitpunkt für die PDF-Erstellung selbst bestimmen

Falls in einem selbst geschriebenen Java-Script verzögert Abfragen ausgeführt werden, dann kann mittels dem Parameter window.print.status = true, der Druck angestoßen werden. Dazu muss aber die Checkbox aktiviert werden. Sonst erfolgt der Druck sobald aus Sicht des Printers das Formular fertig geladen ist und Skripte ausgeführt wurden. Hierbei handelt es sich um eine fortgeschrittene Einstellung und sollte nur verwendet werden, wenn dies wirklich gebraucht wird.

Dateiname

Dateiname, unter dem das erzeugte PDF-Dokument gespeichert wird.

An den Vorgang anhängen

Die Datei dauerhaft speichern. Diese Einstellung ist auch notwendig, wenn die Datei z.B. auf einer Abschlussseite als Download (mittels Systemplatzhalter/Attachment-Platzhalter) angeboten werden soll.

CSS-Anpassungen für Druckbild

Allgemeine CSS-Anpassungen für den Druck können über eine entsprechende Media-Query umgesetzt werden:

@media print {
   /* general CSS for printing */
}

Hier ist zu beachten, dass dieses CSS auch angwandt wird, wenn das Formular etwa direkt über den Browser gedruck wird.

Weiterhin gibt es speziell für den Print-Service noch folgende spezielle CSS-Klassen, welche immer an das form.xm-form-Element angefügt werden (erfordert mindestens Print-Plugin Version 4.2.0 und Print-Server-Plugin 1.4.0).

xm-print

Wird immer angefügt.

xm-print--mode-plain

Wird angefügt, wenn als Druckmodus Formularfelder bewahren ausgewählt ist.

xm-print--mode-dynamic

Wird angefügt, wenn als Druckmodus Formularfelder in Text umwandeln ausgewählt ist.

xm-print--style-filled

Wird angefügt, wenn die Option Blankodruck deaktiviert ist.

xm-print--style-blank

Wird angefügt, wenn die Option Blankodruck aktiviert ist.

Textfelder und Auswahllisten

Zur Optimierung des PDF-Dokuments für den Druck werden Formularelemente vom Typ Eingabefeld, Textarea und Auswahl (Drop-Down) in reine Textfelder umgewandelt, falls als Druckmodus Formularfelder in Text umwandeln eingestellt ist. Zudem werden diese mit der CSS-Klasse print und XSpan versehen, welches für Anpassungen des Aussehens verwendet werden kann. Um etwas die Schriftgröße zu ändern, kann folgendes CSS verwendet werden:

.print.XSpan {
   font-size: 18pt;
   font-family: serif;
}

Um einige Eigenschaften des Standard-CSS zu überschreiben, welches mit FORMCYCLE ausgeliefert wird, können spezifischerer Selektoren verwendet werden, wie beispielsweise

.xm-form .xm-content div.print.XSpan {
  font-size: 18pt;
  font-family: serif;
}

Bei den meisten Eigenschaften ist dies jedoch nicht nötig.

Seitenumbruch erzwingen

Um einen definierten Seitenumbruch zu erzeugen, sind die page-break Attribute per CSS zu setzen. Dabei ist der entsprechende Container bzw. Element per xn-Attribut zu selektieren. Hierbei müssen Sie beachten, dass die Css-Eigenschaft display auf block gesetzt werden, sonst wird kein Zeilenumbruch erzeugt. In diesem Beispiel soll vor dem Container div1 ein Umbruch erzeugt werden.

[data-xn=div2] {
   display: block !important;
   page-break-before: always;
}

Seitenumbruch verhindern

Die Standardeinstellung beim Druck sieht vor, dass nach jeder Formularseite ein Umbruch eingefügt wird:

@media print {
    .CXPage:not(:first-child ), .page-break {
        display: block !important;
        page-break-before: always;
    }
}

Um die Umbrüche zu vermeiden ist im Formularen folgende Regel im Reiter CSS zu hinterlegen:

@media print {
    .CXPage:not(:first-child ) {
        page-break-before: avoid;
    }
}

Verwendung von anderen Schriftarten

Technische Voraussetzungen

Damit Schriftarten in den erstellten PDF-Dokumenten verwendet und eingebettet werden, ist es im allgemeinen nötig, dass diese auf dem Server auf dem FORMCYCLE bzw. das Print-Service-Plugin läuft installiert sind.

Einbinden im CSS

Zum Einbinden einer auf dem Server installierten Schriftart für den Druck, muss diese mit einem @media print-Query explizit definiert und für die Verwendung durch die entsprechenden Formularelemente gesetzt werden. Im einfachsten Fall kann dies wie im folgenden Beispiel aussehen:

@media print {
    @font-face {
        font-family: 'DejaVu Sans';
        src: local('DejaVu Sans');
    }
    .xm-form.modern *, .modern .XPage * {
        font-family: "DejaVu Sans";
    }
}

Hierbei ist es insbesondere wichtig, dass die bei local() eingetragene Bezeichung dem Namen der Schriftart entspricht.

Rechtliche Hinweise

Schriftarten haben zum Teil sehr eng umgrenzte Lizenzbedingungen und werden je nach Einsatzzweck unterschiedlich bepreist. Es ist zu beachten, dass Schriftarten für das Erstellen von PDFs in diese eingebettet werden müssen, was bei vielen kommerziellen Schriftarten eine andere Lizenz als für das Ausliefern über einen Webserver für den Zweck der Darstellung einer Webseite in einem Webbrowser verlangt.

In Schriftarten vom Typ TrueType und OpenType können Informationen über die Einbettbarkeit der Schriftart direkt mitgespeichert werden. Je nachdem, was dort konfiguriert ist, kann eine Schriftart gegebenenfalls nicht eingebettet werden und wird vom Print-Service-Plugin stattdessen nur als Vektorgrafik in die erstellten PDF-Dokumente gerendert.

JavaScript-Anpassungen für Druckbild

Manchmal kann es erforderlich sein, vor dem Druck noch JavaScript auszuführen. Hierzu kann die Funktion $.xutil.onPrint verwendet werden, welche folgende Signatur hat

function onPrint(callback: () => Promise | void): void

Mit dieser Funktion können ein oder mehrere Callbacks registriert werden, welche vor dem Druck ausgeführt werden. Wenn ein Callback ein Promise zurückliefert, wird nicht eher gedruckt, bis das Promise erfüllt ist. Falls das Promise abgewiesen wird, wird der Fehler gelogged, der Print aber nicht abgebrochen. Zu beachten ist weiterhin, dass die Registrierung der Callbacks vor dem Druck erfolgen muss, also beispielsweise innerhalb eines JQuery-Document-Ready-Handlers ($(callback)).

Hinweis: Der Druck wird allerdings abgebrochen, wenn das eingestellte Timeout in der Aktion erreicht wurde.

Falls beispielsweise ein AJAX-Request fertig ausgeführt werden soll, bevor mit dem Druck begonnen wird:

  $.xutil.onPrint(async () => {
    const response = await fetch("http://some-url.de");
    // do something with response
  });

Versionshistorie Plugin

5.0.0

• Erfordert mindestens Version 8 von formcycle. Anpassungen für Version 8 von formcycle

4.4.4

• Korrektur Plugin wird wieder korrekt von formcycle Version 8 erkannt und kann aktualisiert werden.

4.4.2

• Korrektur Links auf Anhänge werden nun in allen Print-Modi deaktiviert.

4.4.1

• Korrektur Links bei Upload-Elementen sind nicht mehr klickbar. Diese haben noch nie funktioniert, da diese eine aktive Sitzungs-ID erfordern.

4.4.0

• Neuerung Es kann nun an der Aktion festgelegt werden, welche Seiten gedruckt werden sollen.

4.3.1

• Fix: Ausgewählter Termin wird immer angezeigt, unabhängig vom ausgewählten Druckmodus

4.3.0

• Feature: Neue Option zum erneuten Versuchen des Drucks bei Fehlern.

4.2.3

• Fix: Sonderzeichen im Wert von Auswahloptionen bei Combobox-Felder werden nun immer korrekt im Druck dargestellt.

4.2.2

• Fix: Bei Textareas, wo die automatische Höhenanpassung aktiviert ist, wird vor dem Druck die Höhe noch einmal neu berechnet.

4.2.1

• Fix: Version des Print-Server beim Check wird korrekt angezeigt

4.2.0

• Feature: Neue Option Blankodruck im Plugin
• Feature: Es werden einige CSS-Klassen xm-print an das  form.xm-form angefügt.
• Change: Ist im Designer unter Print-Einstellungen (Word- und PDF-Export-Optionen) eingestellt, dass ein Element versteckt sein soll, wird dieses auch im Druck nicht mitgedruckt. FÜr dieses Features ist FORMCYCLE Version 7.0.14 oder höher erforderlich.
• Change: Betrifft den Druckmodus dynamisch: Hatte ein Eingabefeld keinen Wert, wurde stattdessen der Platzhalter (placeholder-Attribute) des Elements als Wert angezeigt. Dies ist verwirrend und wurde geändert. Hat ein Eingabefeld keinen Wert, wird auch kein Wert dargestellt.
• Change: Betrifft den Druckmodus dynamisch: Hatte ein Auswahlfeld mit Darstellung Dropdown keinen Wert, wurde Bitte auswählen als Wert angezeigt. Dies wurde so geändert, dass nun kein Wert angezeigt wird.

4.1.2

• Hinweis in der Plugin-Oberfläche bezüglich $.xutil.onPrint ergänzt.

4.1.1

• Erfordert wenigstens FORMCYCLE in Version 7.0.4.
• Change: Pflichtfeldhinweis wird nicht mehr angezeigt
• Fix: Datumformat wird wieder sofort eingeblendet

4.1.0

• Status zum Drucken kann ausgewählt werden. Ist kein Status ausgewählt, wird wie bisher der aktuelle Status des Vorgangs genommen.
• Konfigurierte Nutzergruppen werden korrekt an der Aktion gespeichert.

4.0.2

• Es kann nun ein Timeout gesetzt werden. Ist der Print-Service nicht erreichbar, wird die Aktion sonst möglicherweise nie abgebrochen.

4.0.1

• Fix: In der Aktion für den neuen Workflow wurde die Datei nicht an den Vorgang angehangen.

4.0.0

• Anpassungen für FORMCYCLE Version 7.