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 localen Server aufgerufen werden (in diesem Beispiel wird versucht die Webseite formcycle.de zu drucken):
133
134 {{code language="none"}}
135 http://localhost:8090/pdf?orientation=landscape&format=A4&wait=false&marginTop=0mm&formURL=http://www.formcycle.de
136 {{/code}}
137
138 == Einrichtung des Plugins ==
139
140 ==== Installation Plugin Print-Service ====
141
142 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]].
143
144 Falls bereits die alte Version des Print-Service Plugins (Phantom-Plugin) installiert war, wird folgende Vorgehensweise für die Installation empfohlen:
145
146 * Phantom-Plugin deaktivieren
147 * Phantom-Plugin löschen
148 * Neues Print-Service Plugin hochladen
149 * Mit der Konfiguration fortfahren
150
151 ==== Konfiguration des Plugins ====
152
153 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.
154
155 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.
156 Zum Beispiel: {{code language="none"}}http://localhost:8089/pdf{{/code}}
157
158 Damit ist die Einrichtung des Print-Service Plugins abgeschlossen und steht als Aktion im Workflow zur Verfügung.
159
160 == Troubleshooting Installation ==
161
162 === Befehl npm wird nicht gefunden ===
163
164 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:
165
166 * Aufruf der Umgebungsvariablen über Systemsteuerung > System > Erweiterte Systemeinstellungen > Button Umgebungsvariblen
167 * Unter Path sollten folgende Einträge zu finden sein: {{info}}C:\Users\{Nutzername}\AppData\Roaming\npm;C:\Program Files\nodejs{{/info}}
168 * Mit Ok bestätigen. Die Konsole muss anschließend mit Adminrechten neu geöffnet werden.
169
170 === Befehl npm install führt zu Timeout ===
171
172 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:
173
174 {{code language="none"}}
175 npm config set proxy http://proxy.domain:port
176 npm config set https-proxy https://proxy.domain:port
177 {{/code}}
178
179 Falls Nutzerdaten erforderlich sind:
180
181 {{code language="none"}}
182 npm config set proxy http://user:pass@proxy.domain:port
183 npm config set https-proxy https://user:pass@proxy.domain:port
184 {{/code}}
185
186 Weitere Informationen sind auch hier zu finden: http://www.fladi.de/2014/02/06/howto-npm-hinter-einem-proxy-verwenden/
187
188 === Druck funktioniert nicht ===
189
190 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}}
191
192 === PDF wird gedruckt, aber es erscheint die Meldung 404 ===
193
194 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.
195
196 === Download Chromium schlägt fehl ===
197
198 Folgende Fehlermeldung erscheint auf der Konsole nach der Ausführung von „npm install“:
199 {{code language="none"}}Error: unable to verify the first certificate{{/code}}
200
201 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!
202
203 {{code language="none"}}
204 PS C:\test> $env:NODE_TLS_REJECT_UNAUTHORIZED = 0
205 PS C:\test> npm set strict-ssl false
206 {{/code}}
207
208 == Optionen der Plugin-Aktion ==
209
210 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:
211
212 : Druck-Modus
213 :; Formularfelder in Text umwandeln
214 :: Eingabefelder werden in Text umgewandelt und das Formular wird in der Breite entsprechend angepasst, siehe nächster Abschnitt.
215 :; Formularfelder bewahren
216 :: Das Formular wird so in dem PDF ausgegeben wie es auch im Browser aussieht.
217
218 ; Papiergröße
219 : Angabe des Formats für das gedruckte Dokument.
220
221 ; Seitenausrichtung
222 : Seiteausrichtung, welche für den Druck verwendet werden soll, Quer- und Hochformat sind möglich.
223
224 ; Hintergrundbilder und Farben berücksichtigen
225 : Hintergrundbilder und Farben werden nicht immer mit berücksichtigt, dies kann hiermit erzwungen werden.
226
227 ; Blankodruck
228 : (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.
229
230 ; Formulartitel in der Kopfzeile anzeigen
231 : Titel des Formulars im Kopfbereich des Dokumentes mitdrucken.
232
233 ; Seitenzahlen in der Fußzeile anzeigen
234 : Seitanzahl in des Fußzeile des Dokumentes mitdrucken.
235
236 ; Datum in der Kopfzeile anzeigen
237 : Aktuelle Daum im Kopfbereich des Dokumentes mitdrucken.
238
239 ; Zoomfaktor
240 : 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.
241
242 ; Rand
243 : Einstellungen für den Rand für oben, links, rechts und unten in Millimeter.
244
245 ; Status beim Drucken
246 : 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.
247
248 ; Benutzergruppen
249 : 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.
250
251 ; URL-Parameter
252 : 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.
253
254 ; Timeout (in Sekunden)
255 : 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.
256
257 ; Zeitpunkt für die PDF-Erstellung selbst bestimmen
258 : 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.
259
260 ; Dateiname
261 : Dateiname, unter dem das erzeugte PDF-Dokument gespeichert wird.
262
263 ; An den Vorgang anhängen
264 : 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.
265
266 == CSS-Anpassungen für Druckbild ==
267
268 Allgemeine CSS-Anpassungen für den Druck können über eine entsprechende Media-Query umgesetzt werden:
269
270 {{code language="css"}}
271 @media print {
272 /* general CSS for printing */
273 }
274 {{/code}}
275
276 Hier ist zu beachten, dass dieses CSS auch angwandt wird, wenn das Formular etwa direkt über den Browser gedruck wird.
277
278 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).
279
280 ; xm-print
281 : Wird immer angefügt.
282 ; xm-print~-~-mode-plain
283 : Wird angefügt, wenn als Druckmodus //Formularfelder bewahren// ausgewählt ist.
284 ; xm-print~-~-mode-dynamic
285 : Wird angefügt, wenn als Druckmodus //Formularfelder in Text umwandeln// ausgewählt ist.
286 ; xm-print~-~-style-filled
287 : Wird angefügt, wenn die Option //Blankodruck// deaktiviert ist.
288 ; xm-print~-~-style-blank
289 : Wird angefügt, wenn die Option //Blankodruck// aktiviert ist.
290
291 === Textfelder und Auswahllisten ===
292
293 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:
294
295 {{code language="css"}}
296 .print.XSpan {
297 font-size: 18pt;
298 font-family: serif;
299 }
300 {{/code}}
301
302 Um einige Eigenschaften des Standard-CSS zu überschreiben, welches mit {{formcycle/}} ausgeliefert wird, können spezifischerer Selektoren verwendet werden, wie beispielsweise
303
304 {{code language="css"}}
305 .xm-form .xm-content div.print.XSpan {
306 font-size: 18pt;
307 font-family: serif;
308 }
309 {{/code}}
310
311 Bei den meisten Eigenschaften ist dies jedoch nicht nötig.
312
313 === Seitenumbruch erzwingen ===
314
315 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.
316
317 {{code language="css"}}
318 [data-xn=div2] {
319 display: block !important;
320 page-break-before: always;
321 }
322 {{/code}}
323
324 === Seitenumbruch verhindern ===
325
326 Die Standardeinstellung beim Druck sieht vor, dass nach jeder Formularseite ein Umbruch eingefügt wird:
327
328 {{code language="css"}}
329 @media print {
330 .CXPage:not(:first-child ), .page-break {
331 display: block !important;
332 page-break-before: always;
333 }
334 }
335 {{/code}}
336
337 Um die Umbrüche zu vermeiden ist im Formularen folgende Regel im Reiter CSS zu hinterlegen:
338
339 {{code language="css"}}
340 @media print {
341 .CXPage:not(:first-child ) {
342 page-break-before: avoid;
343 }
344 }
345 {{/code}}
346
347 === Verwendung von anderen Schriftarten ===
348
349 ==== Technische Voraussetzungen ====
350
351 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.
352 {{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.
353 ##{{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}}
354
355 ==== Einbinden im CSS ====
356
357 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:
358
359 {{code language="css"}}
360 @media print {
361 @font-face {
362 font-family: 'DejaVu Sans';
363 src: local('DejaVu Sans');
364 }
365 .xm-form.modern *, .modern .XPage * {
366 font-family: "DejaVu Sans";
367 }
368 }
369 {{/code}}
370
371 Hierbei ist es insbesondere wichtig, dass die bei {{code language="none"}}local(){{/code}} eingetragene Bezeichung dem Namen der Schriftart entspricht.
372
373 ==== Rechtliche Hinweise ====
374
375 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.
376
377 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.
378
379 == JavaScript-Anpassungen für Druckbild ==
380
381 Manchmal kann es erforderlich sein, vor dem Druck noch JavaScript auszuführen. Hierzu kann die Funktion //$.xutil.onPrint// verwendet werden, welche folgende Signatur hat
382
383 {{code language="text"}}
384 function onPrint(callback: () => Promise<void> | void): void
385 {{/code}}
386
387 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)//).
388
389 Falls beispielsweise ein AJAX-Request fertig ausgeführt werden soll, bevor mit dem Druck begonnen wird:
390
391 {{js}}
392 $.xutil.onPrint(async () => {
393 const response = await fetch("http://some-url.de");
394 // do something with response
395 });
396 {{/js}}
397
398 {{jsIE}}
399 $.xutil.onPrint(function() {
400 return new Promise(function(resolve, reject) {
401 $.ajax("http://some-url.de", {
402 success: function(data, textStatus, jqXHR) {
403 // Do something with the response data
404 resolve(undefined);
405 },
406 error: function(jqXHR, textStatus, errorThrown) {
407 reject("HTTP request error: " + textStatus + " - " + errorThrown);
408 },
409 });
410 });
411 });
412 {{/jsIE}}
413
414 == Versionshistorie ==
415
416 === Plugin ===
417
418 ==== 4.2.3 ====
419
420 * Fix: Sonderzeichen im Wert von Auswahloptionen bei Combobox-Felder werden nun immer korrekt im Druck dargestellt.
421
422 ==== 4.2.2 ====
423
424 * Fix: Bei Textareas, wo die automatische Höhenanpassung aktiviert ist, wird vor dem Druck die Höhe noch einmal neu berechnet.
425
426 ==== 4.2.1 ====
427
428 * Fix: Version des Print-Server beim Check wird korrekt angezeigt
429
430 ==== 4.2.0 ====
431
432 * Feature: Neue Option //Blankodruck// im Plugin
433 * Feature: Es werden einige CSS-Klassen //xm-print// an das //form.xm-form// angefügt.
434 * 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.
435 * 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.
436 * 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.
437
438 ==== 4.1.2 ====
439
440 * Hinweis in der Plugin-Oberfläche bezüglich //$.xutil.onPrint// ergänzt.
441
442 ==== 4.1.1 ====
443
444 * Erfordert wenigstens {{formcycle/}} in Version 7.0.4.
445 * Change: Pflichtfeldhinweis wird nicht mehr angezeigt
446 * Fix: Datumformat wird wieder sofort eingeblendet
447
448 ==== 4.1.0 ====
449
450 * Status zum Drucken kann ausgewählt werden. Ist kein Status ausgewählt, wird wie bisher der aktuelle Status des Vorgangs genommen.
451 * Konfigurierte Nutzergruppen werden korrekt an der Aktion gespeichert.
452
453 ==== 4.0.2 ====
454
455 * Es kann nun ein Timeout gesetzt werden. Ist der Print-Service nicht erreichbar, wird die Aktion sonst möglicherweise nie abgebrochen.
456
457 ==== 4.0.1 ====
458
459 * Fix: In der Aktion für den neuen Workflow wurde die Datei nicht an den Vorgang angehangen.
460
461 ==== 4.0.0 ====
462
463 * Anpassungen für {{formcycle/}} Version 7.
464
465 === Server ===
466
467 ==== 1.5.1 ====
468
469 * Abhängigkeit node-windows aktualisiert
470
471 ==== 1.5.0 ====
472
473 * Update auf Chromium 105.0.5173.0
474 * Erfordert mindestens Node.JS 14 oder höher
475
476 ==== 1.4.1 ====
477
478 * Script zum Installieren / Deinstallieren des Windows-Services ist wieder lauffähig (//install-windows-service.js// und //uninstall-windows-service.js//)
479
480 ==== 1.4.0 ====
481
482 * Bei Fehlern während des Druckens wird dieser Fehler mit der HTTP-Antwort zurückgeliefert
483 * 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.
484 * Bei Aufruf des Pfads ///pdf// liefer der Print-Server nun eine Status-Report des Servers zurück.