Wiki-Quellcode von Print-Service Plugin

Zeige letzte Bearbeiter
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
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 {{content/}}
8
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.
10
11 == Technische Besonderheiten ==
12
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
15 == Installation Print Server unter Windows ==
16
17 Die Installation des benötigten //Print Servers// erfordert je nach Betriebssystem unterschiedlicher Vorgehensweisen.
18
19 ==== Installation von Node.js ====
20
21 : 1. Download der LTS-Version unter https://nodejs.org/
22 : 2. MSI-Datei ausführen
23 : 3. Wizard-Schritte durchlaufen, wobei die Standardeinstellungen so belassen werden können
24
25 ==== Installationsschritte für den Print Server ====
26
27 : 4. Die Print Server Installationsdateien können Sie hier über die Customer-Cloud herunterladen.
28 : 5. Entpacken Sie die ZIP Datei „print_server_fc.zip“ und verschieben Sie den Inhalt in den Ordner print_server_fc unter C:\Programme\.
29 : 6. Zur Installation öffnen Sie die Kommandozeile (cmd) mit administrativen Berechtigungen und führen die folgenden Befehle aus:
30
31 {{code language="none"}}
32 cd C:\Programme\print_server_fc
33 npm install
34 npm install -g node-windows
35 npm link node-windows
36 node install-windows-service.js
37 {{/code}}
38
39 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.
40
41 * 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.
42 * 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}}.
43
44 Nach der Installation wird ein Ordner mit dem Namen {{code language="none"}}daemon{{/code}} für die Logdateien angelegt.
45
46 === Deinstallation ===
47
48 Für die Deinstallation des Print Servers, öffnen Sie eine Kommandozeile (cmd) mit administrativen Berechtigungen und führen Sie folgende Befehle aus.
49
50 {{code language="none"}}
51 cd C:\Programme\print_server_fc
52 node uninstall-windows-service.js
53 {{/code}}
54
55 === Aktualisierung ===
56
57 Prinzipiell ist eine Aktualisierung möglich, indem der Print-Service deinstalliert und anschließend neu installiert wird.
58
59 In den meisten Fällen reicht es allerdings aus, die Server-Script-Dateien zu ersetzen und die Abhängigkeiten per npm zu aktualsieren:
60
61 * Die aktuelle Version "print_server_fc.zip" herunterladen.
62 * Den Print-Service-Windows-Dienst stoppen.
63 * 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).
64 * Wichtig: Der Ordner {{code language="none"}}daemon{{/code}} und die darin enthaltenen Dateien sollten dabei nicht geändert werden!
65 * Eine Window-Kommandozeile (cmd) mit administrativen Berechtigungen öffnen
66 * In den //print_server_fc// Ordner wechseln, wohin die Dateien kopiert wurden.
67 * 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 * Nun kann der Print-Service-Windows-Dienst wieder gestartet werden.
69
70 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.
71
72 == Installation Print Server unter Linux ==
73
74 ==== Installationsschritte für die Installation von Node.js und dem Print Server ====
75
76 Zur Installation öffnen Sie die Konsole und führen die folgenden Befehle aus:
77
78 {{code language="none"}}
79 # Laden des Skriptes (je nach Betriebssystem unterschiedlich)
80
81 # Debian 10 - Wenn Sie als root angemeldet sind:
82 wget "https://customer.formcycle.eu/index.php/s/0GBtp1HtQHJMzQx/download?path=/&files=install_printserver_debian10.sh" -O install_print_server.sh
83
84 # Debian 10 - oder wenn Sie als normaler Benutzer mit Sudo-Rechten angemeldet sind:
85 wget "https://customer.formcycle.eu/index.php/s/0GBtp1HtQHJMzQx/download?path=/&files=install_printserver_debian10_sudo.sh" -O install_print_server.sh
86
87 # Ubuntu 16 - Wenn Sie als root angemeldet sind:
88 wget "https://customer.formcycle.eu/index.php/s/0GBtp1HtQHJMzQx/download?path=/&files=install_printserver_ubuntu16.sh" -O install_print_server.sh
89
90
91 # Datei Ausführbar machen
92 chmod 750 install_print_server.sh
93
94 # Installation starten
95 ./install_print_server.sh
96
97 # Print Server ausführen
98 systemctl start printserver
99 {{/code}}
100
101 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.
102 Ü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.
103
104 === Deinstallation ===
105
106 Für die Deinstallation des Print Servers, öffnen Sie eine Kommandozeile (cmd) mit administrativen Berechtigungen und führen Sie folgende Befehle aus:
107
108 {{code language="none"}}
109 /home/formcycle/deinstall_printserver.sh
110 {{/code}}
111
112 {{info}}
113 **Achtung:**
114 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!
115 {{/info}}
116
117 === Aktualisierung ===
118
119 Prinzipiell ist eine Aktualisierung möglich, indem der Print-Service deinstalliert und anschließend neu installiert wird.
120
121 In den meisten Fällen reicht es allerdings aus, die Server-Script-Dateien zu ersetzen und die Abhängigkeiten per npm zu aktualsieren:
122
123 * Die aktuelle Version "print_server_fc.zip" herunterladen.
124 * Den Print-Service-Systemdienst FORMCYCLE Print Sever stoppen: {{code language="none"}}systemctl stop printserver{{/code}}
125 * 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 überschreiben" auswählen).
126 * Eine Kommandozeile (cmd) mit administrativen Berechtigungen öffnen und in den Ordner wechseln, wohin die Dateien kopiert wurden. Di Dateien sollten standardmäßig unter (% id="cke_bm_219S" style="display:none" %) (%%) {{code language="none"}}/home/formcycle/print_server{{/code}} zu finden sein.
127 * 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.
128 * Nun kann der Print-Service-Systemdienst wieder gestartet werden: {{code language="none"}}systemctl start printserver{{/code}}
129
130 === Test ===
131
132 Um zu prüfen, ob die Installation erfolgreich durchgeführt wurde, kann der Service testweise auf dem Server aufgerufen werden:
133 {{code language="none"}}http://localhost:8090/pdf?orientation=landscape&format=A4&wait=false&marginTop=0mm&formURL=http://www.formcycle.de{{/code}}
134
135 === Einrichtung des Plugins ===
136
137 ==== Installation Plugin Print-Service ====
138
139 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]].
140
141 Falls bereits die alte Version des Print-Service Plugins (Phantom-Plugin) installiert war, wird folgende Vorgehensweise für die Installation empfohlen:
142
143 * Phantom-Plugin deaktivieren
144 * Phantom-Plugin löschen
145 * Neues Print-Service Plugin hochladen
146 * Mit der Konfiguration fortfahren
147
148 ==== Konfiguration des Plugins ====
149
150 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.
151
152 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.
153 Zum Beispiel: {{code language="none"}}http://localhost:8089/pdf{{/code}}
154
155 Damit ist die Einrichtung des Print-Service Plugins abgeschlossen und steht als Aktion im Workflow zur Verfügung.
156
157 == Troubleshooting Installation ==
158
159 === Befehl npm wird nicht gefunden ===
160
161 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:
162
163 * Aufruf der Umgebungsvariablen über Systemsteuerung > System > Erweiterte Systemeinstellungen > Button Umgebungsvariblen
164 * Unter Path sollten folgende Einträge zu finden sein: {{info}}C:\Users\{Nutzername}\AppData\Roaming\npm;C:\Program Files\nodejs{{/info}}
165 * Mit Ok bestätigen. Die Konsole muss anschließend mit Adminrechten neu geöffnet werden.
166
167 === Befehl npm install führt zu Timeout ===
168
169 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:
170
171 {{code language="none"}}
172 npm config set proxy http://proxy.domain:port
173 npm config set https-proxy https://proxy.domain:port
174 {{/code}}
175
176 Falls Nutzerdaten erforderlich sind:
177
178 {{code language="none"}}
179 npm config set proxy http://user:pass@proxy.domain:port
180 npm config set https-proxy https://user:pass@proxy.domain:port
181 {{/code}}
182
183 Weitere Informationen sind auch hier zu finden: http://www.fladi.de/2014/02/06/howto-npm-hinter-einem-proxy-verwenden/
184
185 === Druck funktioniert nicht ===
186
187 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}}
188
189 === PDF wird gedruckt, aber es erscheint die Meldung 404 ===
190
191 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.
192
193 === Download Chromium schlägt fehl ===
194
195 Folgende Fehlermeldung erscheint auf der Konsole nach der Ausführung von „npm install“:
196 {{code language="none"}}Error: unable to verify the first certificate{{/code}}
197
198 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!
199
200 {{code language="none"}}
201 PS C:\test> $env:NODE_TLS_REJECT_UNAUTHORIZED = 0
202 PS C:\test> npm set strict-ssl false
203 {{/code}}
204
205 == Optionen der Plugin-Aktion ==
206
207 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:
208
209 : Druck-Modus
210 :; Formularfelder in Text umwandeln
211 :: Eingabefelder werden in Text umgewandelt und das Formular wird in der Breite entsprechend angepasst, siehe nächster Abschnitt.
212 :; Formularfelder bewahren
213 :: Das Formular wird so in dem PDF ausgegeben wie es auch im Browser aussieht.
214
215 ; Papiergröße
216 : Angabe des Formats für das gedruckte Dokument.
217
218 ; Seitenausrichtung
219 : Seiteausrichtung, welche für den Druck verwendet werden soll, Quer- und Hochformat sind möglich.
220
221 ; Hintergrundbilder und Farben berücksichtigen
222 : Hintergrundbilder und Farben werden nicht immer mit berücksichtigt, dies kann hiermit erzwungen werden.
223
224 ; Blankodruck
225 : (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.
226
227 ; Formulartitel in der Kopfzeile anzeigen
228 : Titel des Formulars im Kopfbereich des Dokumentes mitdrucken.
229
230 ; Seitenzahlen in der Fußzeile anzeigen
231 : Seitanzahl in des Fußzeile des Dokumentes mitdrucken.
232
233 ; Datum in der Kopfzeile anzeigen
234 : Aktuelle Daum im Kopfbereich des Dokumentes mitdrucken.
235
236 ; Zoomfaktor
237 : 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.
238
239 ; Rand
240 : Einstellungen für den Rand für oben, links, rechts und unten in Millimeter.
241
242 ; Status beim Drucken
243 : 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.
244
245 ; Benutzergruppen
246 : 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.
247
248 ; URL-Parameter
249 : 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.
250
251 ; Timeout (in Sekunden)
252 : 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.
253
254 ; Zeitpunkt für die PDF-Erstellung selbst bestimmen
255 : 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.
256
257 ; Dateiname
258 : Dateiname, unter dem das erzeugte PDF-Dokument gespeichert wird.
259
260 ; An den Vorgang anhängen
261 : 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.
262
263 == CSS-Anpassungen für Druckbild ==
264
265 Allgemeine CSS-Anpassungen für den Druck können über eine entsprechende Media-Query umgesetzt werden:
266
267 {{code language="css"}}
268 @media print {
269 /* general CSS for printing */
270 }
271 {{/code}}
272
273 Hier ist zu beachten, dass dieses CSS auch angwandt wird, wenn das Formular etwa direkt über den Browser gedruck wird.
274
275 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).
276
277 ; xm-print
278 : Wird immer angefügt.
279 ; xm-print~-~-mode-plain
280 : Wird angefügt, wenn als Druckmodus //Formularfelder bewahren// ausgewählt ist.
281 ; xm-print~-~-mode-dynamic
282 : Wird angefügt, wenn als Druckmodus //Formularfelder in Text umwandeln// ausgewählt ist.
283 ; xm-print~-~-style-filled
284 : Wird angefügt, wenn die Option //Blankodruck// deaktiviert ist.
285 ; xm-print~-~-style-blank
286 : Wird angefügt, wenn die Option //Blankodruck// aktiviert ist.
287
288 === Textfelder und Auswahllisten ===
289
290 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:
291
292 {{code language="css"}}
293 .print.XSpan {
294 font-size: 18pt;
295 font-family: serif;
296 }
297 {{/code}}
298
299 Um einige Eigenschaften des Standard-CSS zu überschreiben, welches mit {{formcycle/}} ausgeliefert wird, können spezifischerer Selektoren verwendet werden, wie beispielsweise
300
301 {{code language="css"}}
302 .xm-form .xm-content div.print.XSpan {
303 font-size: 18pt;
304 font-family: serif;
305 }
306 {{/code}}
307
308 Bei den meisten Eigenschaften ist dies jedoch nicht nötig.
309
310 === Seitenumbruch erzwingen ===
311
312 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.
313
314 {{code language="css"}}
315 [data-xn=div2] {
316 display: block !important;
317 page-break-before: always;
318 }
319 {{/code}}
320
321 === Seitenumbruch verhindern ===
322
323 Die Standardeinstellung beim Druck sieht vor, dass nach jeder Formularseite ein Umbruch eingefügt wird:
324
325 {{code language="css"}}
326 @media print {
327 .CXPage:not(:first-child ), .page-break {
328 display: block !important;
329 page-break-before: always;
330 }
331 }
332 {{/code}}
333
334 Um die Umbrüche zu vermeiden ist im Formularen folgende Regel im Reiter CSS zu hinterlegen:
335
336 {{code language="css"}}
337 @media print {
338 .CXPage:not(:first-child ) {
339 page-break-before: avoid;
340 }
341 }
342 {{/code}}
343
344 === Verwendung von anderen Schriftarten ===
345
346 ==== Technische Voraussetzungen ====
347
348 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.
349 {{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.
350 ##{{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}}
351
352 ==== Einbinden im CSS ====
353
354 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:
355
356 {{code language="css"}}
357 @media print {
358 @font-face {
359 font-family: 'DejaVu Sans';
360 src: local('DejaVu Sans');
361 }
362 .xm-form.modern *, .modern .XPage * {
363 font-family: "DejaVu Sans";
364 }
365 }
366 {{/code}}
367
368 Hierbei ist es insbesondere wichtig, dass die bei {{code language="none"}}local(){{/code}} eingetragene Bezeichung dem Namen der Schriftart entspricht.
369
370 ==== Rechtliche Hinweise ====
371
372 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.
373
374 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.
375
376 == JavaScript-Anpassungen für Druckbild ==
377
378 Manchmal kann es erforderlich sein, vor dem Druck noch JavaScript auszuführen. Hierzu kann die Funktion //$.xutil.onPrint// verwendet werden, welche folgende Signatur hat
379
380 {{code language="text"}}
381 function onPrint(callback: () => Promise<void> | void): void
382 {{/code}}
383
384 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)//).
385
386 Falls beispielsweise ein AJAX-Request fertig ausgeführt werden soll, bevor mit dem Druck begonnen wird:
387
388 {{js}}
389 $.xutil.onPrint(async () => {
390 const response = await fetch("http://some-url.de");
391 // do something with response
392 });
393 {{/js}}
394
395 {{jsIE}}
396 $.xutil.onPrint(function() {
397 return new Promise(function(resolve, reject) {
398 $.ajax("http://some-url.de", {
399 success: function(data, textStatus, jqXHR) {
400 // Do something with the response data
401 resolve(undefined);
402 },
403 error: function(jqXHR, textStatus, errorThrown) {
404 reject("HTTP request error: " + textStatus + " - " + errorThrown);
405 },
406 });
407 });
408 });
409 {{/jsIE}}
410
411 == Versionshistorie ==
412
413 === Plugin ===
414
415 ==== 4.2.3 ====
416
417 * Fix: Sonderzeichen im Wert von Auswahloptionen bei Combobox-Felder werden nun immer korrekt im Druck dargestellt.
418
419 ==== 4.2.2 ====
420
421 * Fix: Bei Textareas, wo die automatische Höhenanpassung aktiviert ist, wird vor dem Druck die Höhe noch einmal neu berechnet.
422
423 ==== 4.2.1 ====
424
425 * Fix: Version des Print-Server beim Check wird korrekt angezeigt
426
427 ==== 4.2.0 ====
428
429 * Feature: Neue Option //Blankodruck// im Plugin
430 * Feature: Es werden einige CSS-Klassen //xm-print// an das //form.xm-form// angefügt.
431 * 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.
432 * 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.
433 * 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.
434
435 ==== 4.1.2 ====
436
437 * Hinweis in der Plugin-Oberfläche bezüglich //$.xutil.onPrint// ergänzt.
438
439 ==== 4.1.1 ====
440
441 * Erfordert wenigstens {{formcycle/}} in Version 7.0.4.
442 * Change: Pflichtfeldhinweis wird nicht mehr angezeigt
443 * Fix: Datumformat wird wieder sofort eingeblendet
444
445 ==== 4.1.0 ====
446
447 * Status zum Drucken kann ausgewählt werden. Ist kein Status ausgewählt, wird wie bisher der aktuelle Status des Vorgangs genommen.
448 * Konfigurierte Nutzergruppen werden korrekt an der Aktion gespeichert.
449
450 ==== 4.0.2 ====
451
452 * Es kann nun ein Timeout gesetzt werden. Ist der Print-Service nicht erreichbar, wird die Aktion sonst möglicherweise nie abgebrochen.
453
454 ==== 4.0.1 ====
455
456 * Fix: In der Aktion für den neuen Workflow wurde die Datei nicht an den Vorgang angehangen.
457
458 ==== 4.0.0 ====
459
460 * Anpassungen für {{formcycle/}} Version 7.
461
462 === Server ===
463
464 ==== 1.5.1 ====
465
466 * Abhängigkeit node-windows aktualisiert
467
468 ==== 1.5.0 ====
469
470 * Update auf Chromium 105.0.5173.0
471 * Erfordert mindestens Node.JS 14 oder höher
472
473 ==== 1.4.1 ====
474
475 * Script zum Installieren / Deinstallieren des Windows-Services ist wieder lauffähig (//install-windows-service.js// und //uninstall-windows-service.js//)
476
477 ==== 1.4.0 ====
478
479 * Bei Fehlern während des Druckens wird dieser Fehler mit der HTTP-Antwort zurückgeliefert
480 * 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.
481 * Bei Aufruf des Pfads ///pdf// liefer der Print-Server nun eine Status-Report des Servers zurück.