Änderungen von Dokument Print-Service-Plugin

Von 4.1 nach 3.1 Von 11.1 nach 10.1

Von Version 10.1

bearbeitet von sas
am 02.03.2022, 14:54

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

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,12 +1,8 @@
  [[**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}}
--Für {{formcycle/}} Version 7 wird das //Print-Service// Plugin in der Version **4.0.0** oder höher benötigt.
--{{/info}}
--
  {{content/}}
--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.
++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 ==
@@ -16,7 +16,7 @@
  Die Installation des benötigten //Print Servers// erfordert je nach Betriebssystem unterschiedlicher Vorgehensweisen.
--=== Installation Print Server unter Windows ===
++===	Installation Print Server unter Windows ===
  ==== Installation von Node.js ====
@@ -43,9 +43,9 @@
  * 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"}}daemon{{/code}} für die Logdateien angelegt.
++Nach der Installation wird ein Ordner mit dem Namen {{code language="none"}}deamon{{/code}} für die Logdateien angelegt.
--=== Deinstallation ===
++==== Deinstallation ====
  Für die Deinstallation des Print Servers, öffnen Sie eine Kommandozeile (cmd) mit administrativen Berechtigungen und führen Sie folgende Befehle aus.
@@ -54,20 +54,7 @@
  node uninstall-windows-service.js
  {{/code}}
--=== 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 {{code language="none"}}server.js{{/code}}, {{code language="none"}}package.json{{/code}} und {{code language="none"}}package-lock.json{{/code}} in den Ordner kopieren, wo der Print-Service aktuell installiert ist (bei Nachfrage "Dateien überscheiben" auswählen).
--* Wichtig: Der Ordner {{code language="none"}}daemon{{/code}} 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 {{code language="none"}}npm install{{/code}} 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 {{code language="none"}}npm config set proxy http:/...{{/code}} gesetzt und per {{code language="none"}}npm config delete proxy{{/code}} wieder gelöscht werden.
--* Nun kann der Print-Service-Windows-Dienst wieder gestartet werden.
--
  === Installation Print Server unter Linux ===
  ==== Installationsschritte für die Installation von Node.js und dem Print Server ====
@@ -90,9 +90,11 @@
  # Datei Ausführbar machen
  chmod 750 install_print_server.sh
++
  # Installation starten
  ./install_print_server.sh
++
  # Print Server ausführen
  systemctl start printserver
  {{/code}}
@@ -100,7 +100,7 @@
  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 ===
++==== Deinstallation ====
  Für die Deinstallation des Print Servers, öffnen Sie eine Kommandozeile (cmd) mit administrativen Berechtigungen und führen Sie folgende Befehle aus:
@@ -113,19 +113,6 @@
  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}}
--=== 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 {{code language="none"}}server.js{{/code}}, {{code language="none"}}package.json{{/code}} und {{code language="none"}}package-lock.json{{/code}} in den Ordner kopieren, wo der Print-Service aktuell installiert ist (bei Nachfrage "Dateien überscheiben" auswählen).
--* In der Kommandozeile in den Ordner wechseln, wohin die Dateien kopiert wurden.
--* Via {{code language="none"}}npm install{{/code}} 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 {{code language="none"}}npm config set proxy http:/...{{/code}} gesetzt und per {{code language="none"}}npm config delete proxy{{/code}} 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:
@@ -135,10 +135,9 @@
  ==== 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>>doc:Formcycle.UserInterface.Client.Plugins.WebHome]].
++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
@@ -151,20 +151,12 @@
  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 im Workflow zur Verfügung.
++Damit ist die Einrichtung des Print-Service Plugins abgeschlossen und steht als Aktion in der Verarbeitung zur Verfügung.
--== Troubleshooting ==
++=== Troubleshooting ===
--=== Befehl npm wird nicht gefunden ===
++==== Befehl npm install führt zu Timeout ====
--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: {{info}}C:\Users\{Nutzername}\AppData\Roaming\npm;C:\Program Files\nodejs{{/info}}
--* 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:
  {{code language="none"}}
@@ -181,18 +181,20 @@
  Weitere Informationen sind auch hier zu finden: http://www.fladi.de/2014/02/06/howto-npm-hinter-einem-proxy-verwenden/
--=== Druck funktioniert nicht ===
++==== 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 ===
++==== 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 ===
++==== 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}}
++{{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!
@@ -203,7 +203,7 @@
  == 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:
++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**
  : Dateiname, unter dem das erzeugte PDF-Dokument gespeichert wird.
@@ -216,18 +216,17 @@
  ; **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>>Formcycle.Designer.Form.URLParameter]]. Auf diese URL-Parameter kann auch von selbstgeschriebenem JavaScript im Scriptbereich zugegriffen werden.
++: 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.
  == CSS-Anpassungen für Druckbild ==
--
  === Textfelder und Auswahllisten ===
--Zur Optimierung des PDF-Dokuments für den Druck werden Formularelemente vom Typ [[Eingabefeld>>Formcycle.Designer.Form.FormElements.Input]], [[Textarea>>Formcycle.Designer.Form.FormElements.Textarea]] und [[Auswahl>>Formcycle.Designer.Form.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:
++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:
  {{code language="css"}}
  .print.XSpan {
--   font-size: 18pt;
--   font-family: serif;
++  font-size: 18pt;
++  font-family: serif;
  }
  {{/code}}
@@ -247,35 +247,12 @@
  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"}}
--[data-xn=div2] {
++[xn=div2] {
     display: block !important;
     page-break-before: always;
  }
  {{/code}}
--=== Seitenumbruch verhindern ===
--
--Die Standardeinstellung beim Druck sieht vor, dass nach jeder Formularseite ein Umbruch eingefügt wird:
--
--{{code language="css"}}
--@media print {
--    .CXPage:not(:first-child ), .page-break {
--        display: block !important;
--        page-break-before: always;
--    }
--}
--{{/code}}
--
--Um die Umbrüche zu vermeiden ist im Formularen folgende Regel im Reiter CSS zu hinterlegen:
--
--{{code language="css"}}
--@media print {
--    .CXPage:not(:first-child ) {
--        page-break-before: avoid;
--    }
--}
--{{/code}}
--
  === Verwendung von anderen Schriftarten ===
  ==== Technische Voraussetzungen ====