Änderungen von Dokument Print-Service-Plugin

Von 2.1 nach 3.1 Von 4.1 nach 4.2

Von Version 3.1

bearbeitet von sas
am 29.03.2021, 21:07

Änderungskommentar: Imported from XAR

Auf Version 4.1

bearbeitet von gru
am 02.09.2021, 08:00

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (2 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Dokument-Autor

@@ -1,1 +1,1 @@
--XWiki.sas
++XWiki.gru

Inhalt

@@ -1,31 +1,173 @@
--[[**Plugin-Download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/plugin-bundle-phantomjs&fileid=342||rel="noopener noreferrer" target="_blank"]] (erfordert Anmeldung)
++[[**Plugin-Download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/fc-plugin-print-service&fileid=8194||rel="noopener noreferrer" target="_blank"]] (erfordert Anmeldung)
--{{info}}
--Bitte verwenden Sie für {{formcycle/}} Version 6 das Plugin ab **Version 2.0.0**.
--{{/info}}
--
  {{content/}}
--Das kostenpflichtige Plugin //Print-Service// ermöglicht es, in der Statusverarbeitung ein PDF aus dem Formular zu erzeugen, welches besser für den Druck geeignet ist.
++Das kostenpflichtige Plugin //Print-Service// ermöglicht es, in der Statusverarbeitung ein PDF aus dem Formular zu erzeugen, welches besser für den Druck geeignet ist.
  == Technische Besonderheiten ==
--Technisch erfolgt die Umsetzung mittels Selenium und dem Treiber //phantomJS//. Das PDF-Dokument wird im Format A4 erzeugt.
++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 {{formcycle/}} Master-Server installiert werden.
--{{warning}}
--Beim Drucken mit dem Print-Service wird JavaScript aus dem Formular ausgeführt. Hierbei muss allerdings beachtet werden, dass hierbei keine neuen JavaScript-Funktionen zur Verfügung stehen. Konkret werden keine Funktionalitäten ab {{smallcaps}}Ecma{{/smallcaps}}Script6 und höher unterstützt. Es können also etwa keine neuen Schlüsselwörter wie //let// und //const// oder neue Syntax wie Arrow-Funktionen oder Destrukturierung verwendet werden.
--{{/warning}}
--
  == Installation ==
--Das Plugin kann als Mandant-Plugin oder System-Plugin installiert werden. Eine Anleitung zur Installation von Plugins finden Sie [[hier>>doc:Formcycle.UserInterface.Client.Plugins.WebHome]].
++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:
++
++{{code language="none"}}
++cd C:\Programme\print_server_fc
++npm install
++npm install -g node-windows
++npm link node-windows
++node install-windows-service.js
++{{/code}}
++
++Es ist nun ein neuer Dienst {{code language="none"}}FORMCYCLE Print Server{{/code}} vorhanden. Bitte prüfen Sie, ob dieser auch gestartet ist, bevor Sie einen [[Test>>||anchor="HTest"]] durchführen. Das Skript {{code language="none"}}install-windows-service.js{{/code}} 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 {{code language="none"}}--port=8090{{/code}} anpassen.
++* Standardmäßig ist Logging aktiviert. Um dies zu ändern setzen Sie den Parameter {{code language="none"}}--verbose=true{{/code}} auf {{code language="none"}}--verbose=false{{/code}}.
++
++Nach der Installation wird ein Ordner mit dem Namen {{code language="none"}}deamon{{/code}} 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.
++
++{{code language="none"}}
++cd C:\Programme\print_server_fc
++node uninstall-windows-service.js
++{{/code}}
++
++
++=== 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:
++
++{{code language="none"}}
++# 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
++{{/code}}
++
++In den ersten Zeilen des Scripts kann noch - über die Variablen {{code language="none"}}PRINTSERVER_USER{{/code}} und {{code language="none"}}PRINTSERVER_USER_PWD{{/code}} - 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 {{code language="none"}}/home/formcycle/print_server{{/code}} 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:
++
++{{code language="none"}}
++/home/formcycle/deinstall_printserver.sh
++{{/code}}
++
  {{info}}
--Es existieren mehrere Versionen des Print-PDF-Plugins für verschiedne Betriebssysteme (//32-Bit Linux//, //64-Bit Linux//, //Windows//, //MacOSX//). Es muss nur die Version des Plugin installiert werden, welche dem Betriebssystem entspricht, auf dem {{formcycle/}} installiert ist. Die Betriebssystemart wird auf der Seite [[Serverinformation>>Formcycle.SystemSettings.UserInterface.ServerInformation]] angezeigt.
++**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!
  {{/info}}
--== Optionen ==
++=== Test ===
++Um zu prüfen, ob die Installation erfolgreich durchgeführt wurde, kann der Service testweise auf dem Server aufgerufen werden:
++{{code language="none"}}http://localhost:8090/pdf?orientation=landscape&format=A4&wait=false&marginTop=0mm&formURL=http://www.formcycle.de{{/code}}
++
++=== Einrichtung des Plugins ===
++
++==== Installation Plugin Print-Service ====
++
++Damit das Plugin in {{formcycle/}} als Aktion in der Verarbeitung zur Verfügung steht, muss dieses im Bereich Systemplugin der Verwaltungsoberfläche bereitgestellt werden. Eine Anleitung zur Installation von Plugins finden Sie [[hier>>doc:Formcycle.UserInterface.Client.Plugins.WebHome]].
++
++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 {{code language="none"}}pdf.print.services.url{{/code}} festgelegt.
++
++Ist die Installation auf dem gleichen Server wie {{formcycle/}} erfolgt, dann ist als Domain {{code language="none"}}localhost{{/code}} anzugeben. Wurden keine Änderungen an dem Port vorgenommen, so bleibt die Einstellung {{code language="none"}}8090{{/code}} beibehalten.
++Zum Beispiel: {{code language="none"}}http://localhost:8089/pdf{{/code}}
++
++Damit ist die Einrichtung des Print-Service Plugins abgeschlossen und steht als Aktion in der Verarbeitung zur Verfügung.
++
++=== Troubleshooting ===
++
++==== 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:
++
++{{code language="none"}}
++npm config set proxy http://proxy.domain:port
++npm config set https-proxy https://proxy.domain:port
++{{/code}}
++
++Falls Nutzerdaten erforderlich sind:
++
++{{code language="none"}}
++npm config set proxy http://user:pass@proxy.domain:port
++npm config set https-proxy https://user:pass@proxy.domain:port
++{{/code}}
++
++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: {{code language="none"}}http://localhost:<port>/formcycle{{/code}}
++
++==== 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“:
++{{code language="none"}}
++Error: unable to verify the first certificate
++{{/code}}
++
++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!
++
++{{code language="none"}}
++PS C:\test> $env:NODE_TLS_REJECT_UNAUTHORIZED = 0
++PS C:\test> npm set strict-ssl false
++{{/code}}
++
++== Optionen der Plugin-Aktion ==
++
  Um das Plugin zu nutzen, klicken Sie in der Statusverarbeitung auf neue Aktion und wählen das Print-Plugin aus. Die folgenden Optionen werden zum Konfigurieren der Plugin-Aktion verwendet:
  ; **Dateiname**
@@ -41,7 +41,8 @@
  ; **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>>Formcycle.FormDesigner.URLParameter]]. Auf diese URL-Parameter kann auch von selbstgeschriebenem JavaScript im Scriptbereich zugegriffen werden.
--== Textfelder und Auswahllisten ==
++== CSS-Anpassungen für Druckbild ==
++=== Textfelder und Auswahllisten ===
  Zur Optimierung des PDF-Dokuments für den Druck werden Formularelemente vom Typ [[Eingabefeld>>Formcycle.FormDesigner.FormElements.Input]], [[Textarea>>Formcycle.FormDesigner.FormElements.Textarea]] und [[Auswahl>>Formcycle.FormDesigner.FormElements.Selection]] (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:
@@ -63,15 +63,26 @@
  Bei den meisten Eigenschaften ist dies jedoch nicht nötig.
--== Verwendung von anderen Schriftarten ==
++=== Seitenumbruch erzwingen ===
--=== Technische Voraussetzungen ===
++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 {{smallcaps}}Css{{/smallcaps}}-Eigenschaft //display// auf //block// gesetzt werden, sonst wird kein Zeilenumbruch erzeugt. In diesem Beispiel soll vor dem Container //div1 //ein Umbruch erzeugt werden.
++{{code language="css"}}
++[xn=div2] {
++   display: block !important;
++   page-break-before: always;
++}
++{{/code}}
++
++=== 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.
  {{velocity}}##Hierbei ist zu beachten, dass die //Java-Laufzeitumgebung// nur beim Start nach den im System registrierten Schriftarten sucht. Da durch einen Neustart des Betriebssystems des Servers sowohl das Betriebssystem als auch die //Java-Laufzeitumgebung// nach neu installierten Schriftarten suchen, ist dies in den meisten Fällen der einfachste Weg, neu installierte Schriftarten für die Verwendung im //Print-Service-Plugin// bereitzustellen.
  ##{{version major="6" minor="6" patch="0"/}}Ab {{formcycle /}} Version 6.6.0 werden die Namen der auf dem Server installierten TTF-Schriftarten in der Übersicht über die verfügbaren Schriftarten auf der Seite [[Serverinformation>>Formcycle.SystemSettings.UserInterface.ServerInformation]] passend angezeigt.{{/velocity}}
--=== Einbinden im CSS ===
++==== Einbinden im CSS ====
  Zum Einbinden einer auf dem Server installierten Schriftart für den Druck, muss diese mit einem {{code language="none"}}@media print{{/code}}-Query explizit definiert und für die Verwendung durch die entsprechenden Formularelemente gesetzt werden. Im einfachsten Fall kann dies wie im folgenden Beispiel aussehen:
@@ -89,7 +89,7 @@
  Hierbei ist es insbesondere wichtig, dass die bei {{code language="none"}}local(){{/code}} eingetragene Bezeichung dem Namen der Schriftart entspricht.
--=== Rechtliche Hinweise ===
++==== 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.