Print-Service Plugin

Plugin-Download (erfordert Anmeldung)

Für Xima® Formcycle Version 7 wird das Print-Service Plugin in der Version 4.0.0 oder höher benötigt.

Inhalt [ Verbergen ]

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

Technische Besonderheiten

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

Installation

Die Installation des benötigten Print Servers erfordert je nach Betriebssystem unterschiedlicher Vorgehensweisen.

Installation Print Server unter Windows

Installation von Node.js

1. Download der LTS-Version unter https://nodejs.org/
2. MSI-Datei ausführen
3. Wizard-Schritte durchlaufen, wobei die Standardeinstellungen so belassen werden können

Installationsschritte für den Print Server

4. Die Print Server Installationsdateien können Sie hier über die Customer-Cloud herunterladen. 
5. Entpacken Sie die ZIP Datei „print_server_fc.zip“ und verschieben Sie den Inhalt in den Ordner print_server_fc unter C:\Programme\.
6. Zur Installation öffnen Sie die Kommandozeile (cmd) mit administrativen Berechtigungen und führen die folgenden Befehle aus:
cd C:\Programme\print_server_fc
npm install
npm install -g node-windows
npm link node-windows
node install-windows-service.js

Es ist nun ein neuer Dienst FORMCYCLE Print Server vorhanden. Bitte prüfen Sie, ob dieser auch gestartet ist, bevor Sie einen Test durchführen. Das Skript install-windows-service.js enthält Standardvariablen für die Installation des Print-Services.

  • Der Dienst wird standardmäßig auf dem Port 8090 installiert. Um diesen zu ändern, müssen Sie in der Datei install-windows-service.js den Parameter --port=8090 anpassen.
  • Standardmäßig ist Logging aktiviert. Um dies zu ändern setzen Sie den Parameter --verbose=true auf --verbose=false.

Nach der Installation wird ein Ordner mit dem Namen daemon für die Logdateien angelegt.

Deinstallation

Für die Deinstallation des Print Servers, öffnen Sie eine Kommandozeile (cmd) mit administrativen Berechtigungen und führen Sie folgende Befehle aus. 

cd C:\Programme\print_server_fc
node uninstall-windows-service.js

Aktualisierung

Prinzipiell ist eine Aktualisierung möglich, indem der Print-Service deinstalliert und anschließend neu installiert wird.

In den meisten Fällen reicht es allerdings aus, die Server-Script-Dateien zu ersetzen und die Abhängigkeiten per npm zu aktualsieren:

  • Die aktuelle Version "print_server_fc.zip" herunterladen.
  • Den Print-Service-Windows-Dienst stoppen.
  • Aus dieser ZIP-Datei die Dateien server.js, package.json und package-lock.json in den Ordner kopieren, wo der Print-Service aktuell installiert ist (bei Nachfrage "Dateien überscheiben" auswählen).
  • Wichtig: Der Ordner daemon und die darin enthaltenen Dateien sollten dabei nicht geändert werden!
  • Eine Window-Kommandozeile (cmd) mit administrativen Berechtigungen öffnen und in den Ordner wechseln, wohin die Dateien kopiert wurden.
  • Via npm install nun die Abhängigkeiten aktualisieren. Dieser Befehl kann einige Momente dauern. Hierfür ist es notwendig, dass der Server eine Internetverbindung hat. Falls eine Verbindung nicht möglich ist, schaue Sie bitte hier.
  • Nun kann der Print-Service-Windows-Dienst wieder gestartet werden.

Sollt das Update dazu führen, dass der Dienst nicht mehr gestartet werden kann, sollten Sie eine Neuinstallation durchfürhen. Heißt erst eine Deinstallation und dann den Schritten unter Installation folgen.

Installation Print Server unter Linux

Installationsschritte für die Installation von Node.js und dem Print Server

Zur Installation öffnen Sie die Konsole und führen die folgenden Befehle aus:

# Laden des Skriptes (je nach Betriebssystem unterschiedlich)

#   Debian 10 - Wenn Sie als root angemeldet sind:
wget "https://customer.formcycle.eu/index.php/s/0GBtp1HtQHJMzQx/download?path=/&files=install_printserver_debian10.sh" -O install_print_server.sh

#   Debian 10 - oder wenn Sie als normaler Benutzer mit Sudo-Rechten angemeldet sind:
wget "https://customer.formcycle.eu/index.php/s/0GBtp1HtQHJMzQx/download?path=/&files=install_printserver_debian10_sudo.sh" -O install_print_server.sh

#   Ubuntu 16 - Wenn Sie als root angemeldet sind:
wget "https://customer.formcycle.eu/index.php/s/0GBtp1HtQHJMzQx/download?path=/&files=install_printserver_ubuntu16.sh" -O install_print_server.sh


# Datei Ausführbar machen
chmod 750 install_print_server.sh

# Installation starten
./install_print_server.sh

# Print Server ausführen
systemctl start printserver

In den ersten Zeilen des Scripts kann noch - über die Variablen PRINTSERVER_USER und PRINTSERVER_USER_PWD - der anzulegende Benutzername/Passwort angepasst werden.
Über den Parameter verbose können Sie die Log-Ausgabe de-/aktvieren. Die Skripte für den Dienst sollten unter /home/formcycle/print_server zu finden sein. In dem Start-Skript kann der verbose-Parameter angepasst werden.

Deinstallation

Für die Deinstallation des Print Servers, öffnen Sie eine Kommandozeile (cmd) mit administrativen Berechtigungen und führen Sie folgende Befehle aus: 

/home/formcycle/deinstall_printserver.sh

Achtung:
Bei der Installation wurden, in Abhängigkeit des vorhandenen Systems, auch einige Linux-Pakete wie z.B. nodejs installiert. Es ist aber nicht möglich, die Pakete automatisiert wieder zu deinstallieren. Löschen Sie die automatisch installierten Pakete nur, wenn Sie zu 100% sicher sind, dass sie nicht mehr benötigt werden!

Aktualisierung

Prinzipiell ist eine Aktualisierung möglich, indem der Print-Service deinstalliert und anschließend neu installiert wird.

In den meisten Fällen reicht es allerdings aus, die Server-Script-Dateien zu ersetzen und die Abhängigkeiten per npm zu aktualsieren:

  • Die aktuelle Version "print_server_fc.zip" herunterladen.
  • Den Print-Service-Systemdienst stoppen.
  • Aus dieser ZIP-Datei die Dateien server.js, package.json und package-lock.json in den Ordner kopieren, wo der Print-Service aktuell installiert ist (bei Nachfrage "Dateien überscheiben" auswählen).
  • Eine Window-Kommandozeile (cmd) mit administrativen Berechtigungen öffnen und in den Ordner wechseln, wohin die Dateien kopiert wurden.
  • Via npm install nun die Abhängigkeiten aktualisieren. Dieser Befehl kann einige Momente dauern. Hierfür ist es notwendig, dass der Server eine Internetverbindung hat. Falls ein Proxy notwendig ist für die Internetverbindung, kann dieser per npm config set proxy http:/... gesetzt und per npm config delete proxy wieder gelöscht werden.
  • Nun kann der Print-Service-Systemdienst wieder gestartet werden.

Test

Um zu prüfen, ob die Installation erfolgreich durchgeführt wurde, kann der Service testweise auf dem Server aufgerufen werden:
http://localhost:8090/pdf?orientation=landscape&format=A4&wait=false&marginTop=0mm&formURL=http://www.formcycle.de

Einrichtung des Plugins

Installation Plugin Print-Service

Damit das Plugin in Xima® 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.

Falls bereits die alte Version des Print-Service Plugins (Phantom-Plugin) installiert war, wird folgende Vorgehensweise für die Installation empfohlen:

  • Phantom-Plugin deaktivieren
  • Phantom-Plugin löschen
  • Neues Print-Service Plugin hochladen
  • Mit der Konfiguration fortfahren

Konfiguration des Plugins

Nachdem das Plugin installiert weurde, 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 Xima® 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.

Troubleshooting

Befehl npm wird nicht gefunden

Unter Windows kann es sein, dass nach der NodeJS Installation die Umgebungsvariablen nicht richtig gesetzt werden und somit npm install nicht ausgeführt werden kann. Zu beobachten war dies auch, wenn nicht der Standardpfad unter C:/Programme bei NodeJS Installation verwendet wurde. Prüfen Sie also im Path, ob diese vorhanden sind. Folgendes ist hierfür zu tun:

  • Aufruf der Umgebungsvariablen über Systemsteuerung > System > Erweiterte Systemeinstellungen > Button Umgebungsvariblen
  • Unter Path sollten folgende Einträge zu finden sein: C:\Users\{Nutzername}\AppData\Roaming\npm;C:\Program Files\nodejs
  • Mit Ok bestätigen. Die Konsole muss anschließend mit Adminrechten neu geöffnet werden.

Befehl npm install führt zu Timeout

Der Befehl npm install funktioniert aufgrund eines Proxys nicht, dann reicht die allgemeine Proxy-Einstellung nicht aus. Daher muss über Konsole folgendes ausgeführt werden:

npm config set proxy http://proxy.domain:port
npm config set https-proxy https://proxy.domain:port

Falls Nutzerdaten erforderlich sind:

npm config set proxy http://user:pass@proxy.domain:port
npm config set https-proxy https://user:pass@proxy.domain:port

Weitere Informationen sind auch hier zu finden: http://www.fladi.de/2014/02/06/howto-npm-hinter-einem-proxy-verwenden/

Druck funktioniert nicht

Falls der Druck über FORMCYCLE nicht möglich ist, könnte die Ursache sein, dass der Print-Service nicht erreichbar ist. Dies kann durch die Loopback-URL behoben werden. Unter System > Allgemein > Loopback URL, Loopback Basis-URL: http://localhost:<port>/formcycle

PDF wird gedruckt, aber es erscheint die Meldung 404

In dem Fall funktioniert der Print-Service korrekt, da bereits ein PDF erzeugt wird. Es muss geprüft werden, ob die Loopback-URL richtig eingetragen ist, damit die URL zum Print-Service richtig aufgelöst wird.

Download Chromium schlägt fehl

Folgende Fehlermeldung erscheint auf der Konsole nach der Ausführung von „npm install“:
Error: unable to verify the first certificate

Bei den beschriebenen Schritten handelt es sich nur um einen Workaround und die Umgebungsvariablen sollten nach der erfolgreichen Installation wieder auf die Standardwerte gesetzt werden!

PS C:\test> $env:NODE_TLS_REJECT_UNAUTHORIZED = 0
PS C:\test> npm set strict-ssl false 

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:

Dateiname
Dateiname, unter dem das erzeugte PDF-Dokument gespeichert wird.
Druckmodus Formular mit textueller Ausgabe von Werten
Eingabefelder werden in Text umgewandelt und das Formular wird in der Breite entsprechend angepasst, siehe nächster Abschnitt.
Druckmodus Formular mit Eingabefeldern
Das Formular wird so in dem PDF ausgegeben wie es auch im Browser aussieht.
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.
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.

CSS-Anpassungen für Druckbild

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 Formular mit textueller Ausgabe von Werten 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 Xima® 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 Xima® Formcycle bzw. das Print-Service-Plugin läuft installiert sind.
Das Makro [velocity] konnte nicht ausgeführt werden. Grund: [The execution of the [velocity] script macro is not allowed in [xwiki:Formcycle.PluginDocumentation.PrintServicePlugin]. Check the rights of its last author or the parameters if it's rendered from another script.]. Klicke auf diese Nachricht, um Details zu erfahren.

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.