Änderungen von Dokument Print-Service-Plugin


Von Version 28.2
bearbeitet von awa
am 08.03.2023, 16:01
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 7.1
bearbeitet von sas
am 02.03.2022, 14:44
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Titel
... ... @@ -1,1 +1,1 @@
1 -Print-Service-Plugin
1 +Print-Service Plugin
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.awa
1 +XWiki.sas
Inhalt
... ... @@ -12,23 +12,20 @@
12 12  
13 13  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.
14 14  
15 -== Installation Print Server unter Windows ==
15 +== Installation ==
16 16  
17 17  Die Installation des benötigten //Print Servers// erfordert je nach Betriebssystem unterschiedlicher Vorgehensweisen.
18 18  
19 -=== Installation von Node.js ===
19 +=== Installation Print Server unter Windows ===
20 20  
21 +==== Installation von Node.js ====
22 +
21 21  : 1. Download der LTS-Version unter https://nodejs.org/
22 22  : 2. MSI-Datei ausführen
23 23  : 3. Wizard-Schritte durchlaufen, wobei die Standardeinstellungen so belassen werden können
24 24  
25 -=== Installationsschritte für den Print Server ===
27 +==== Installationsschritte für den Print Server ====
26 26  
27 -{{info}}
28 - Im Gegensatz zu früheren Versionen müssen ALLE Dateien aus der ZIP-Datei mit dem Print-Server kopiert werden.
29 -{{/info}}
30 -
31 -
32 32  : 4. Die Print Server Installationsdateien können Sie hier über die Customer-Cloud herunterladen.
33 33  : 5. Entpacken Sie die ZIP Datei „print_server_fc.zip“ und verschieben Sie den Inhalt in den Ordner print_server_fc unter C:\Programme\.
34 34  : 6. Zur Installation öffnen Sie die Kommandozeile (cmd) mit administrativen Berechtigungen und führen die folgenden Befehle aus:
... ... @@ -48,7 +48,7 @@
48 48  
49 49  Nach der Installation wird ein Ordner mit dem Namen {{code language="none"}}daemon{{/code}} für die Logdateien angelegt.
50 50  
51 -=== Deinstallation ===
48 +==== Deinstallation ====
52 52  
53 53  Für die Deinstallation des Print Servers, öffnen Sie eine Kommandozeile (cmd) mit administrativen Berechtigungen und führen Sie folgende Befehle aus.
54 54  
... ... @@ -57,6 +57,7 @@
57 57  node uninstall-windows-service.js
58 58  {{/code}}
59 59  
57 +
60 60  === Aktualisierung ===
61 61  
62 62  Prinzipiell ist eine Aktualisierung möglich, indem der Print-Service deinstalliert und anschließend neu installiert wird.
... ... @@ -65,19 +65,16 @@
65 65  
66 66  * Die aktuelle Version "print_server_fc.zip" herunterladen.
67 67  * Den Print-Service-Windows-Dienst stoppen.
68 -* Aus dieser ZIP-Datei alle Dateien in den Ordner kopieren, wo der Print-Service aktuell installiert ist (bei Nachfrage "Dateien überscheiben" auswählen).
66 +* 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).
69 69  * Wichtig: Der Ordner {{code language="none"}}daemon{{/code}} und die darin enthaltenen Dateien sollten dabei nicht geändert werden!
70 -* Eine Window-Kommandozeile (cmd) mit administrativen Berechtigungen öffnen
71 -* In den //print_server_fc// Ordner wechseln, wohin die Dateien kopiert wurden.
72 -* 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"]].
68 +* Eine Window-Kommandozeile (cmd) mit administrativen Berechtigungen öffnen und in den Ordner wechseln, wohin die Dateien kopiert wurden.
69 +* 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.
73 73  * Nun kann der Print-Service-Windows-Dienst wieder gestartet werden.
74 74  
75 -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 +=== Installation Print Server unter Linux ===
76 76  
77 -== Installation Print Server unter Linux ==
74 +==== Installationsschritte r die Installation von Node.js und dem Print Server ====
78 78  
79 -=== Installationsschritte für die Installation von Node.js und dem Print Server ===
80 -
81 81  Zur Installation öffnen Sie die Konsole und führen die folgenden Befehle aus:
82 82  
83 83  {{code language="none"}}
... ... @@ -96,9 +96,11 @@
96 96  # Datei Ausführbar machen
97 97  chmod 750 install_print_server.sh
98 98  
94 +
99 99  # Installation starten
100 100  ./install_print_server.sh
101 101  
98 +
102 102  # Print Server ausführen
103 103  systemctl start printserver
104 104  {{/code}}
... ... @@ -106,7 +106,7 @@
106 106  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.
107 107  Ü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.
108 108  
109 -=== Deinstallation ===
106 +==== Deinstallation ====
110 110  
111 111  Für die Deinstallation des Print Servers, öffnen Sie eine Kommandozeile (cmd) mit administrativen Berechtigungen und führen Sie folgende Befehle aus:
112 112  
... ... @@ -126,24 +126,21 @@
126 126  In den meisten Fällen reicht es allerdings aus, die Server-Script-Dateien zu ersetzen und die Abhängigkeiten per npm zu aktualsieren:
127 127  
128 128  * Die aktuelle Version "print_server_fc.zip" herunterladen.
129 -* Den Print-Service-Systemdienst FORMCYCLE Print Sever stoppen: {{code language="none"}}systemctl stop printserver{{/code}}
130 -* Die Dateien aus dieser Zip-Datei in den Ordner kopieren, wo der Print-Service aktuell installiert ist (bei Nachfrage "Dateien überschreiben" auswählen). (% id="cke_bm_32515S" style="display:none" %) (%%)Die Dateien sollten standardmäßig unter (% id="cke_bm_219S" style="display:none" %) (%%) {{code language="none"}}/home/formcycle/print_server{{/code}} zu finden sein.
131 -* Eine Kommandozeile (cmd) mit administrativen Berechtigungen öffnen und in den Ordner wechseln, wohin die Dateien kopiert wurden. Die Dateien sollten standardmäßig unter (% id="cke_bm_219S" style="display:none" %) (%%) {{code language="none"}}/home/formcycle/print_server{{/code}} zu finden sein.
126 +* Den Print-Service-Systemdienst stoppen.
127 +* 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).
128 +* In der Kommandozeile in den Ordner wechseln, wohin die Dateien kopiert wurden.
132 132  * 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.
133 -* Nun kann der Print-Service-Systemdienst wieder gestartet werden: {{code language="none"}}systemctl start printserver{{/code}}
130 +* Nun kann der Print-Service-Systemdienst wieder gestartet werden.
134 134  
135 -== Test ==
132 +=== Test ===
136 136  
137 -Um zu prüfen, ob die Installation erfolgreich durchgeführt wurde, kann der Service testweise auf dem localen Server aufgerufen werden (in diesem Beispiel wird versucht die Webseite formcycle.de zu drucken):
134 +Um zu prüfen, ob die Installation erfolgreich durchgeführt wurde, kann der Service testweise auf dem Server aufgerufen werden:
135 +{{code language="none"}}http://localhost:8090/pdf?orientation=landscape&format=A4&wait=false&marginTop=0mm&formURL=http://www.formcycle.de{{/code}}
138 138  
139 -{{code language="none"}}
140 -http://localhost:8090/pdf?orientation=landscape&format=A4&wait=false&marginTop=0mm&formURL=http://www.formcycle.de
141 -{{/code}}
137 +=== Einrichtung des Plugins ===
142 142  
143 -== Einrichtung des Plugins ==
139 +==== Installation Plugin Print-Service ====
144 144  
145 -=== Installation Plugin Print-Service ===
146 -
147 147  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]].
148 148  
149 149  Falls bereits die alte Version des Print-Service Plugins (Phantom-Plugin) installiert war, wird folgende Vorgehensweise für die Installation empfohlen:
... ... @@ -153,7 +153,7 @@
153 153  * Neues Print-Service Plugin hochladen
154 154  * Mit der Konfiguration fortfahren
155 155  
156 -=== Konfiguration des Plugins ===
150 +==== Konfiguration des Plugins ====
157 157  
158 158  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.
159 159  
... ... @@ -162,9 +162,9 @@
162 162  
163 163  Damit ist die Einrichtung des Print-Service Plugins abgeschlossen und steht als Aktion im Workflow zur Verfügung.
164 164  
165 -== Troubleshooting Installation ==
159 +=== Troubleshooting ===
166 166  
167 -=== Befehl npm wird nicht gefunden ===
161 +==== Befehl npm wird nicht gefunden ====
168 168  
169 169  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:
170 170  
... ... @@ -172,8 +172,10 @@
172 172  * Unter Path sollten folgende Einträge zu finden sein: {{info}}C:\Users\{Nutzername}\AppData\Roaming\npm;C:\Program Files\nodejs{{/info}}
173 173  * Mit Ok bestätigen. Die Konsole muss anschließend mit Adminrechten neu geöffnet werden.
174 174  
175 -=== Befehl npm install führt zu Timeout ===
169 +Unter Linux sollte geprüft werden ob NodeJS auch installiert wurde.
176 176  
171 +==== Befehl npm install führt zu Timeout ====
172 +
177 177  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:
178 178  
179 179  {{code language="none"}}
... ... @@ -190,15 +190,15 @@
190 190  
191 191  Weitere Informationen sind auch hier zu finden: http://www.fladi.de/2014/02/06/howto-npm-hinter-einem-proxy-verwenden/
192 192  
193 -=== Druck funktioniert nicht ===
189 +==== Druck funktioniert nicht ====
194 194  
195 195  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}}
196 196  
197 -=== PDF wird gedruckt, aber es erscheint die Meldung 404 ===
193 +==== PDF wird gedruckt, aber es erscheint die Meldung 404 ====
198 198  
199 199  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.
200 200  
201 -=== Download Chromium schlägt fehl ===
197 +==== Download Chromium schlägt fehl ====
202 202  
203 203  Folgende Fehlermeldung erscheint auf der Konsole nach der Ausführung von „npm install“:
204 204  {{code language="none"}}Error: unable to verify the first certificate{{/code}}
... ... @@ -214,88 +214,24 @@
214 214  
215 215  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:
216 216  
217 -: Druck-Modus
218 -:; Formularfelder in Text umwandeln
219 -:: Eingabefelder werden in Text umgewandelt und das Formular wird in der Breite entsprechend angepasst, siehe nächster Abschnitt.
220 -:; Formularfelder bewahren
221 -:: Das Formular wird so in dem PDF ausgegeben wie es auch im Browser aussieht.
222 -
223 -; Papiergröße
224 -: Angabe des Formats für das gedruckte Dokument.
225 -
226 -; Seitenausrichtung
227 -: Seiteausrichtung, welche für den Druck verwendet werden soll, Quer- und Hochformat sind möglich.
228 -
229 -; Hintergrundbilder und Farben berücksichtigen
230 -: Hintergrundbilder und Farben werden nicht immer mit berücksichtigt, dies kann hiermit erzwungen werden.
231 -
232 -; Blankodruck
233 -: (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.
234 -
235 -; Formulartitel in der Kopfzeile anzeigen
236 -: Titel des Formulars im Kopfbereich des Dokumentes mitdrucken.
237 -
238 -; Seitenzahlen in der Fußzeile anzeigen
239 -: Seitanzahl in des Fußzeile des Dokumentes mitdrucken.
240 -
241 -; Datum in der Kopfzeile anzeigen
242 -: Aktuelle Daum im Kopfbereich des Dokumentes mitdrucken.
243 -
244 -; Zoomfaktor
213 +; **Dateiname**
214 +: Dateiname, unter dem das erzeugte PDF-Dokument gespeichert wird.
215 +; **Druckmodus Formular mit textueller Ausgabe von Werten**
216 +: Eingabefelder werden in Text umgewandelt und das Formular wird in der Breite entsprechend angepasst, siehe nächster Abschnitt.
217 +; **Druckmodus Formular mit Eingabefeldern**
218 +: Das Formular wird so in dem PDF ausgegeben wie es auch im Browser aussieht.
219 +; **Zoomfaktor**
245 245  : 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.
246 -
247 -; Rand
248 -: Einstellungen für den Rand für oben, links, rechts und unten in Millimeter.
249 -
250 -; Status beim Drucken
251 -: In Abhängigkeit von einem bestimmten Status drucken. Durch die Einstellungsmöglichkeit [[Verfügbar wenn>>doc:Formcycle.Designer.Form.ElementProperties.AvailableOnlyIf||target="_blank"]], können Formularelemente abhängig vom Status ausgeblendet werden und somit kann das Druckbild beeinflusst werden.
252 -
253 -; Benutzergruppen
221 +; **Benutzergruppen**
254 254  : 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.
255 -
256 -; URL-Parameter
223 +; **URL-Parameter**
257 257  : 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.
258 258  
259 -; Timeout (in Sekunden)
260 -: 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.
261 -
262 -; Zeitpunkt für die PDF-Erstellung selbst bestimmen
263 -: 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.
264 -
265 -; Dateiname
266 -: Dateiname, unter dem das erzeugte PDF-Dokument gespeichert wird.
267 -
268 -; An den Vorgang anhängen
269 -: Die Datei dauerhaft speichern. Diese Einstellung ist auch notwendig, wenn die Datei z.B. auf einer Abschlussseite als Download (mittels [[Attachment-Platzhalter>>doc:Formcycle.UserInterface.Variables||anchor="HSystemplatzhalterfFCrHTML-Templates" target="_blank"]]) angeboten werden soll.
270 -
271 271  == CSS-Anpassungen für Druckbild ==
272 272  
273 -Allgemeine CSS-Anpassungen für den Druck können über eine entsprechende Media-Query umgesetzt werden:
274 -
275 -{{code language="css"}}
276 -@media print {
277 - /* general CSS for printing */
278 -}
279 -{{/code}}
280 -
281 -Hier ist zu beachten, dass dieses CSS auch angwandt wird, wenn das Formular etwa direkt über den Browser gedruck wird.
282 -
283 -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).
284 -
285 -; xm-print
286 -: Wird immer angefügt.
287 -; xm-print~-~-mode-plain
288 -: Wird angefügt, wenn als Druckmodus //Formularfelder bewahren// ausgewählt ist.
289 -; xm-print~-~-mode-dynamic
290 -: Wird angefügt, wenn als Druckmodus //Formularfelder in Text umwandeln// ausgewählt ist.
291 -; xm-print~-~-style-filled
292 -: Wird angefügt, wenn die Option //Blankodruck// deaktiviert ist.
293 -; xm-print~-~-style-blank
294 -: Wird angefügt, wenn die Option //Blankodruck// aktiviert ist.
295 -
296 296  === Textfelder und Auswahllisten ===
297 297  
298 -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 //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:
230 +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:
299 299  
300 300  {{code language="css"}}
301 301  .print.XSpan {
... ... @@ -377,132 +377,6 @@
377 377  
378 378  ==== Rechtliche Hinweise ====
379 379  
380 -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.
312 +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.
381 381  
382 382  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.
383 -
384 -== JavaScript-Anpassungen für Druckbild ==
385 -
386 -Manchmal kann es erforderlich sein, vor dem Druck noch JavaScript auszuführen. Hierzu kann die Funktion //$.xutil.onPrint// verwendet werden, welche folgende Signatur hat
387 -
388 -{{code language="text"}}
389 -function onPrint(callback: () => Promise<void> | void): void
390 -{{/code}}
391 -
392 -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 mit dem Druck gewartet, 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)//).
393 -
394 -Falls beispielsweise ein AJAX-Request fertig ausgeführt werden soll, bevor mit dem Druck begonnen wird:
395 -
396 -{{js}}
397 - $.xutil.onPrint(async () => {
398 - const response = await fetch("http://some-url.de");
399 - // do something with response
400 - });
401 -{{/js}}
402 -
403 -{{jsIE}}
404 - $.xutil.onPrint(function() {
405 - return new Promise(function(resolve, reject) {
406 - $.ajax("http://some-url.de", {
407 - success: function(data, textStatus, jqXHR) {
408 - // Do something with the response data
409 - resolve(undefined);
410 - },
411 - error: function(jqXHR, textStatus, errorThrown) {
412 - reject("HTTP request error: " + textStatus + " - " + errorThrown);
413 - },
414 - });
415 - });
416 - });
417 -{{/jsIE}}
418 -
419 -== Versionshistorie ==
420 -
421 -=== Plugin ===
422 -
423 -==== 4.3.0 ====
424 -
425 -* Feature: Neue Option zum erneuten Versuchen des Drucks bei Fehlern.
426 -
427 -==== 4.2.3 ====
428 -
429 -* Fix: Sonderzeichen im Wert von Auswahloptionen bei Combobox-Felder werden nun immer korrekt im Druck dargestellt.
430 -
431 -==== 4.2.2 ====
432 -
433 -* Fix: Bei Textareas, wo die automatische Höhenanpassung aktiviert ist, wird vor dem Druck die Höhe noch einmal neu berechnet.
434 -
435 -==== 4.2.1 ====
436 -
437 -* Fix: Version des Print-Server beim Check wird korrekt angezeigt
438 -
439 -==== 4.2.0 ====
440 -
441 -* Feature: Neue Option //Blankodruck// im Plugin
442 -* Feature: Es werden einige CSS-Klassen //xm-print// an das //form.xm-form// angefügt.
443 -* 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.
444 -* 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.
445 -* 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.
446 -
447 -==== 4.1.2 ====
448 -
449 -* Hinweis in der Plugin-Oberfläche bezüglich //$.xutil.onPrint// ergänzt.
450 -
451 -==== 4.1.1 ====
452 -
453 -* Erfordert wenigstens {{formcycle/}} in Version 7.0.4.
454 -* Change: Pflichtfeldhinweis wird nicht mehr angezeigt
455 -* Fix: Datumformat wird wieder sofort eingeblendet
456 -
457 -==== 4.1.0 ====
458 -
459 -* Status zum Drucken kann ausgewählt werden. Ist kein Status ausgewählt, wird wie bisher der aktuelle Status des Vorgangs genommen.
460 -* Konfigurierte Nutzergruppen werden korrekt an der Aktion gespeichert.
461 -
462 -==== 4.0.2 ====
463 -
464 -* Es kann nun ein Timeout gesetzt werden. Ist der Print-Service nicht erreichbar, wird die Aktion sonst möglicherweise nie abgebrochen.
465 -
466 -==== 4.0.1 ====
467 -
468 -* Fix: In der Aktion für den neuen Workflow wurde die Datei nicht an den Vorgang angehangen.
469 -
470 -==== 4.0.0 ====
471 -
472 -* Anpassungen für {{formcycle/}} Version 7.
473 -
474 -=== Server ===
475 -
476 -==== 1.7.0 ====
477 -
478 -* Emuliere Media-Type print vor Druck und warte, bis kein Netzwerk-Traffic mehr herrscht. Hilft dabei, dass etwa Bilder aus @media-print-Regeln angezeigt werden.
479 -
480 -==== 1.6.1 ====
481 -
482 -* Fix compatibility with Windows service installation script
483 -
484 -==== 1.6.0 ====
485 -
486 -* Es wird nun Chromium 108.0.5351.0 zum Drucken genutzt.
487 -* Neues CLI-Flag //~-~-disableCache=true// zum Deaktivieren des Browser-Cache.
488 -* Neues CLI-Flag //~-~-isolatedBrowser=true// um einen separaten Browser für jeden Print-Request zu verwenden.
489 -* Fix Debian Install-Script, installiere auch libgbm1.
490 -
491 -==== 1.5.1 ====
492 -
493 -* Abhängigkeit node-windows aktualisiert
494 -
495 -==== 1.5.0 ====
496 -
497 -* Update auf Chromium 105.0.5173.0
498 -* Erfordert mindestens Node.JS 14 oder höher
499 -
500 -==== 1.4.1 ====
501 -
502 -* Script zum Installieren / Deinstallieren des Windows-Services ist wieder lauffähig (//install-windows-service.js// und //uninstall-windows-service.js//)
503 -
504 -==== 1.4.0 ====
505 -
506 -* Bei Fehlern während des Druckens wird dieser Fehler mit der HTTP-Antwort zurückgeliefert
507 -* Print-Server kann nun zum Drucken beliebiger Webseiten genutzt werden. JavaScript und CSS, welche im Kontext der zu druckenden Seite ausgeführt werden soll, kann nun mit der HTTP-Anfrage übergeben werden.
508 -* Bei Aufruf des Pfads ///pdf// liefer der Print-Server nun eine Status-Report des Servers zurück.