Änderungen von Dokument Print-Service-Plugin


Von Version 12.1
bearbeitet von sas
am 11.03.2022, 10:16
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 4.2
bearbeitet von gru
am 02.09.2021, 08:06
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.sas
1 +XWiki.gru
Inhalt
... ... @@ -1,9 +1,5 @@
1 1  [[**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)
2 2  
3 -{{info}}
4 -Für {{formcycle/}} Version 7 wird das //Print-Service// Plugin in der Version **4.0.0** oder höher benötigt.
5 -{{/info}}
6 -
7 7  {{content/}}
8 8  
9 9  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.
... ... @@ -16,7 +16,7 @@
16 16  
17 17  Die Installation des benötigten //Print Servers// erfordert je nach Betriebssystem unterschiedlicher Vorgehensweisen.
18 18  
19 -=== Installation Print Server unter Windows ===
15 +=== Installation Print Server unter Windows ===
20 20  
21 21  ==== Installation von Node.js ====
22 22  
... ... @@ -43,9 +43,9 @@
43 43  * 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.
44 44  * 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}}.
45 45  
46 -Nach der Installation wird ein Ordner mit dem Namen {{code language="none"}}daemon{{/code}} für die Logdateien angelegt.
42 +Nach der Installation wird ein Ordner mit dem Namen {{code language="none"}}deamon{{/code}} für die Logdateien angelegt.
47 47  
48 -=== Deinstallation ===
44 +==== Deinstallation ====
49 49  
50 50  Für die Deinstallation des Print Servers, öffnen Sie eine Kommandozeile (cmd) mit administrativen Berechtigungen und führen Sie folgende Befehle aus.
51 51  
... ... @@ -54,22 +54,7 @@
54 54  node uninstall-windows-service.js
55 55  {{/code}}
56 56  
57 -=== Aktualisierung ===
58 58  
59 -Prinzipiell ist eine Aktualisierung möglich, indem der Print-Service deinstalliert und anschließend neu installiert wird.
60 -
61 -In den meisten Fällen reicht es allerdings aus, die Server-Script-Dateien zu ersetzen und die Abhängigkeiten per npm zu aktualsieren:
62 -
63 -* Die aktuelle Version "print_server_fc.zip" herunterladen.
64 -* Den Print-Service-Windows-Dienst stoppen.
65 -* 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).
66 -* Wichtig: Der Ordner {{code language="none"}}daemon{{/code}} und die darin enthaltenen Dateien sollten dabei nicht geändert werden!
67 -* Eine Window-Kommandozeile (cmd) mit administrativen Berechtigungen öffnen und in den Ordner wechseln, wohin die Dateien kopiert wurden.
68 -* 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 eine Verbindung nicht möglich ist, schaue Sie bitte [[hier>>doc:||anchor="HBefehlnpminstallfFChrtzuTimeout"]].
69 -* Nun kann der Print-Service-Windows-Dienst wieder gestartet werden.
70 -
71 -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.
72 -
73 73  === Installation Print Server unter Linux ===
74 74  
75 75  ==== Installationsschritte für die Installation von Node.js und dem Print Server ====
... ... @@ -92,9 +92,11 @@
92 92  # Datei Ausführbar machen
93 93  chmod 750 install_print_server.sh
94 94  
76 +
95 95  # Installation starten
96 96  ./install_print_server.sh
97 97  
80 +
98 98  # Print Server ausführen
99 99  systemctl start printserver
100 100  {{/code}}
... ... @@ -102,7 +102,7 @@
102 102  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.
103 103  Ü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.
104 104  
105 -=== Deinstallation ===
88 +==== Deinstallation ====
106 106  
107 107  Für die Deinstallation des Print Servers, öffnen Sie eine Kommandozeile (cmd) mit administrativen Berechtigungen und führen Sie folgende Befehle aus:
108 108  
... ... @@ -115,19 +115,6 @@
115 115  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!
116 116  {{/info}}
117 117  
118 -=== Aktualisierung ===
119 -
120 -Prinzipiell ist eine Aktualisierung möglich, indem der Print-Service deinstalliert und anschließend neu installiert wird.
121 -
122 -In den meisten Fällen reicht es allerdings aus, die Server-Script-Dateien zu ersetzen und die Abhängigkeiten per npm zu aktualsieren:
123 -
124 -* Die aktuelle Version "print_server_fc.zip" herunterladen.
125 -* Den Print-Service-Systemdienst stoppen.
126 -* 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).
127 -* Eine Window-Kommandozeile (cmd) mit administrativen Berechtigungen öffnen und in den Ordner wechseln, wohin die Dateien kopiert wurden.
128 -* 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.
129 -* Nun kann der Print-Service-Systemdienst wieder gestartet werden.
130 -
131 131  === Test ===
132 132  
133 133  Um zu prüfen, ob die Installation erfolgreich durchgeführt wurde, kann der Service testweise auf dem Server aufgerufen werden:
... ... @@ -140,7 +140,6 @@
140 140  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]].
141 141  
142 142  Falls bereits die alte Version des Print-Service Plugins (Phantom-Plugin) installiert war, wird folgende Vorgehensweise für die Installation empfohlen:
143 -
144 144  * Phantom-Plugin deaktivieren
145 145  * Phantom-Plugin löschen
146 146  * Neues Print-Service Plugin hochladen
... ... @@ -155,18 +155,10 @@
155 155  
156 156  Damit ist die Einrichtung des Print-Service Plugins abgeschlossen und steht als Aktion im Workflow zur Verfügung.
157 157  
158 -== Troubleshooting ==
127 +=== Troubleshooting ===
159 159  
160 -=== Befehl npm wird nicht gefunden ===
129 +==== Befehl npm install führt zu Timeout ====
161 161  
162 -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:
163 -
164 -* Aufruf der Umgebungsvariablen über Systemsteuerung > System > Erweiterte Systemeinstellungen > Button Umgebungsvariblen
165 -* Unter Path sollten folgende Einträge zu finden sein: {{info}}C:\Users\{Nutzername}\AppData\Roaming\npm;C:\Program Files\nodejs{{/info}}
166 -* Mit Ok bestätigen. Die Konsole muss anschließend mit Adminrechten neu geöffnet werden.
167 -
168 -=== Befehl npm install führt zu Timeout ===
169 -
170 170  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:
171 171  
172 172  {{code language="none"}}
... ... @@ -183,18 +183,20 @@
183 183  
184 184  Weitere Informationen sind auch hier zu finden: http://www.fladi.de/2014/02/06/howto-npm-hinter-einem-proxy-verwenden/
185 185  
186 -=== Druck funktioniert nicht ===
147 +==== Druck funktioniert nicht ====
187 187  
188 188  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}}
189 189  
190 -=== PDF wird gedruckt, aber es erscheint die Meldung 404 ===
151 +==== PDF wird gedruckt, aber es erscheint die Meldung 404 ====
191 191  
192 192  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.
193 193  
194 -=== Download Chromium schlägt fehl ===
155 +==== Download Chromium schlägt fehl ====
195 195  
196 196  Folgende Fehlermeldung erscheint auf der Konsole nach der Ausführung von „npm install“:
197 -{{code language="none"}}Error: unable to verify the first certificate{{/code}}
158 +{{code language="none"}}
159 +Error: unable to verify the first certificate
160 +{{/code}}
198 198  
199 199  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!
200 200  
... ... @@ -221,7 +221,6 @@
221 221  : 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.
222 222  
223 223  == CSS-Anpassungen für Druckbild ==
224 -
225 225  === Textfelder und Auswahllisten ===
226 226  
227 227  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:
... ... @@ -228,8 +228,8 @@
228 228  
229 229  {{code language="css"}}
230 230  .print.XSpan {
231 - font-size: 18pt;
232 - font-family: serif;
193 + font-size: 18pt;
194 + font-family: serif;
233 233  }
234 234  {{/code}}
235 235  
... ... @@ -249,35 +249,12 @@
249 249  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.
250 250  
251 251  {{code language="css"}}
252 -[data-xn=div2] {
214 +[xn=div2] {
253 253   display: block !important;
254 254   page-break-before: always;
255 255  }
256 256  {{/code}}
257 257  
258 -=== Seitenumbruch verhindern ===
259 -
260 -Die Standardeinstellung beim Druck sieht vor, dass nach jeder Formularseite ein Umbruch eingefügt wird:
261 -
262 -{{code language="css"}}
263 -@media print {
264 - .CXPage:not(:first-child ), .page-break {
265 - display: block !important;
266 - page-break-before: always;
267 - }
268 -}
269 -{{/code}}
270 -
271 -Um die Umbrüche zu vermeiden ist im Formularen folgende Regel im Reiter CSS zu hinterlegen:
272 -
273 -{{code language="css"}}
274 -@media print {
275 - .CXPage:not(:first-child ) {
276 - page-break-before: avoid;
277 - }
278 -}
279 -{{/code}}
280 -
281 281  === Verwendung von anderen Schriftarten ===
282 282  
283 283  ==== Technische Voraussetzungen ====