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