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