Wiki-Quellcode von Print-Service-Plugin


Verstecke letzte Bearbeiter
gru 4.1 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)
gru 1.1 2
gru 4.3 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
gru 1.1 7 {{content/}}
8
gru 4.2 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.
gru 1.1 10
11 == Technische Besonderheiten ==
12
gru 4.1 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.
gru 1.1 14
sas 22.1 15 == Installation Print Server unter Windows ==
gru 1.1 16
gru 4.1 17 Die Installation des benötigten //Print Servers// erfordert je nach Betriebssystem unterschiedlicher Vorgehensweisen.
gru 1.1 18
sas 25.1 19 === Installation von Node.js ===
gru 4.1 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
sas 25.1 25 === Installationsschritte für den Print Server ===
gru 4.1 26
awa 28.2 27 {{info}}
28 Im Gegensatz zu früheren Versionen müssen ALLE Dateien aus der ZIP-Datei mit dem Print-Server kopiert werden.
29 {{/info}}
30
31
gru 4.1 32 : 4. Die Print Server Installationsdateien können Sie hier über die Customer-Cloud herunterladen.
33 : 5. Entpacken Sie die ZIP Datei „print_server_fc.zip“ und verschieben Sie den Inhalt in den Ordner print_server_fc unter C:\Programme\.
34 : 6. Zur Installation öffnen Sie die Kommandozeile (cmd) mit administrativen Berechtigungen und führen die folgenden Befehle aus:
35
36 {{code language="none"}}
37 cd C:\Programme\print_server_fc
38 npm install
39 npm install -g node-windows
40 npm link node-windows
41 node install-windows-service.js
42 {{/code}}
43
44 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.
45
46 * 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.
47 * 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}}.
48
awa 6.1 49 Nach der Installation wird ein Ordner mit dem Namen {{code language="none"}}daemon{{/code}} für die Logdateien angelegt.
gru 4.1 50
sas 9.1 51 === Deinstallation ===
gru 4.1 52
53 Für die Deinstallation des Print Servers, öffnen Sie eine Kommandozeile (cmd) mit administrativen Berechtigungen und führen Sie folgende Befehle aus.
54
55 {{code language="none"}}
56 cd C:\Programme\print_server_fc
57 node uninstall-windows-service.js
58 {{/code}}
59
awa 6.1 60 === Aktualisierung ===
61
62 Prinzipiell ist eine Aktualisierung möglich, indem der Print-Service deinstalliert und anschließend neu installiert wird.
63
64 In den meisten Fällen reicht es allerdings aus, die Server-Script-Dateien zu ersetzen und die Abhängigkeiten per npm zu aktualsieren:
65
66 * Die aktuelle Version "print_server_fc.zip" herunterladen.
67 * Den Print-Service-Windows-Dienst stoppen.
awa 26.5 68 * Aus dieser ZIP-Datei alle Dateien in den Ordner kopieren, wo der Print-Service aktuell installiert ist (bei Nachfrage "Dateien überscheiben" auswählen).
awa 6.1 69 * Wichtig: Der Ordner {{code language="none"}}daemon{{/code}} und die darin enthaltenen Dateien sollten dabei nicht geändert werden!
sas 18.1 70 * Eine Window-Kommandozeile (cmd) mit administrativen Berechtigungen öffnen
71 * In den //print_server_fc// Ordner wechseln, wohin die Dateien kopiert wurden.
sas 12.1 72 * Via {{code language="none"}}npm install{{/code}} nun die Abhängigkeiten aktualisieren. Dieser Befehl kann einige Momente dauern. Hierfür ist es notwendig, dass der Server eine Internetverbindung hat. Falls eine Verbindung nicht möglich ist, schaue Sie bitte [[hier>>doc:||anchor="HBefehlnpminstallfFChrtzuTimeout"]].
awa 6.1 73 * Nun kann der Print-Service-Windows-Dienst wieder gestartet werden.
74
sas 12.1 75 Sollt das Update dazu führen, dass der Dienst nicht mehr gestartet werden kann, sollten Sie eine Neuinstallation durchfürhen. Heißt erst eine Deinstallation und dann den Schritten unter Installation folgen.
76
sas 22.1 77 == Installation Print Server unter Linux ==
gru 4.1 78
sas 26.1 79 === Installationsschritte für die Installation von Node.js und dem Print Server ===
gru 4.1 80
81 Zur Installation öffnen Sie die Konsole und führen die folgenden Befehle aus:
82
83 {{code language="none"}}
84 # Laden des Skriptes (je nach Betriebssystem unterschiedlich)
85
86 # Debian 10 - Wenn Sie als root angemeldet sind:
87 wget "https://customer.formcycle.eu/index.php/s/0GBtp1HtQHJMzQx/download?path=/&files=install_printserver_debian10.sh" -O install_print_server.sh
88
89 # Debian 10 - oder wenn Sie als normaler Benutzer mit Sudo-Rechten angemeldet sind:
90 wget "https://customer.formcycle.eu/index.php/s/0GBtp1HtQHJMzQx/download?path=/&files=install_printserver_debian10_sudo.sh" -O install_print_server.sh
91
92 # Ubuntu 16 - Wenn Sie als root angemeldet sind:
93 wget "https://customer.formcycle.eu/index.php/s/0GBtp1HtQHJMzQx/download?path=/&files=install_printserver_ubuntu16.sh" -O install_print_server.sh
94
95
96 # Datei Ausführbar machen
97 chmod 750 install_print_server.sh
98
99 # Installation starten
100 ./install_print_server.sh
101
102 # Print Server ausführen
103 systemctl start printserver
104 {{/code}}
105
106 In den ersten Zeilen des Scripts kann noch - über die Variablen {{code language="none"}}PRINTSERVER_USER{{/code}} und {{code language="none"}}PRINTSERVER_USER_PWD{{/code}} - der anzulegende Benutzername/Passwort angepasst werden.
107 Über den Parameter verbose können Sie die Log-Ausgabe de-/aktvieren. Die Skripte für den Dienst sollten unter {{code language="none"}}/home/formcycle/print_server{{/code}} zu finden sein. In dem Start-Skript kann der verbose-Parameter angepasst werden.
108
sas 9.1 109 === Deinstallation ===
gru 4.1 110
111 Für die Deinstallation des Print Servers, öffnen Sie eine Kommandozeile (cmd) mit administrativen Berechtigungen und führen Sie folgende Befehle aus:
112
113 {{code language="none"}}
114 /home/formcycle/deinstall_printserver.sh
115 {{/code}}
116
sas 3.1 117 {{info}}
gru 4.1 118 **Achtung:**
119 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!
sas 3.1 120 {{/info}}
gru 1.1 121
awa 6.1 122 === Aktualisierung ===
123
124 Prinzipiell ist eine Aktualisierung möglich, indem der Print-Service deinstalliert und anschließend neu installiert wird.
125
126 In den meisten Fällen reicht es allerdings aus, die Server-Script-Dateien zu ersetzen und die Abhängigkeiten per npm zu aktualsieren:
127
128 * Die aktuelle Version "print_server_fc.zip" herunterladen.
sas 20.1 129 * Den Print-Service-Systemdienst FORMCYCLE Print Sever stoppen: {{code language="none"}}systemctl stop printserver{{/code}}
sas 27.1 130 * Die Dateien aus dieser Zip-Datei in den Ordner kopieren, wo der Print-Service aktuell installiert ist (bei Nachfrage "Dateien überschreiben" auswählen). (% id="cke_bm_32515S" style="display:none" %) (%%)Die Dateien sollten standardmäßig unter (% id="cke_bm_219S" style="display:none" %) (%%) {{code language="none"}}/home/formcycle/print_server{{/code}} zu finden sein.
131 * Eine Kommandozeile (cmd) mit administrativen Berechtigungen öffnen und in den Ordner wechseln, wohin die Dateien kopiert wurden. Die Dateien sollten standardmäßig unter (% id="cke_bm_219S" style="display:none" %) (%%) {{code language="none"}}/home/formcycle/print_server{{/code}} zu finden sein.
awa 6.1 132 * Via {{code language="none"}}npm install{{/code}} nun die Abhängigkeiten aktualisieren. Dieser Befehl kann einige Momente dauern. Hierfür ist es notwendig, dass der Server eine Internetverbindung hat. Falls ein Proxy notwendig ist für die Internetverbindung, kann dieser per {{code language="none"}}npm config set proxy http:/...{{/code}} gesetzt und per {{code language="none"}}npm config delete proxy{{/code}} wieder gelöscht werden.
sas 21.1 133 * Nun kann der Print-Service-Systemdienst wieder gestartet werden: {{code language="none"}}systemctl start printserver{{/code}}
awa 6.1 134
sas 23.1 135 == Test ==
gru 1.1 136
sas 23.1 137 Um zu prüfen, ob die Installation erfolgreich durchgeführt wurde, kann der Service testweise auf dem localen Server aufgerufen werden (in diesem Beispiel wird versucht die Webseite formcycle.de zu drucken):
gru 4.1 138
sas 23.1 139 {{code language="none"}}
140 http://localhost:8090/pdf?orientation=landscape&format=A4&wait=false&marginTop=0mm&formURL=http://www.formcycle.de
141 {{/code}}
gru 4.1 142
sas 23.1 143 == Einrichtung des Plugins ==
144
sas 24.1 145 === Installation Plugin Print-Service ===
gru 4.1 146
gru 4.2 147 Damit das Plugin in {{formcycle/}} als Aktion im Workflow zur Verfügung steht, muss dieses im Bereich Systemplugin der Verwaltungsoberfläche bereitgestellt werden. Eine Anleitung zur Installation von Plugins finden Sie [[hier>>doc:Formcycle.UserInterface.Client.Plugins.WebHome]].
gru 4.1 148
149 Falls bereits die alte Version des Print-Service Plugins (Phantom-Plugin) installiert war, wird folgende Vorgehensweise für die Installation empfohlen:
sas 5.1 150
gru 4.1 151 * Phantom-Plugin deaktivieren
152 * Phantom-Plugin löschen
153 * Neues Print-Service Plugin hochladen
154 * Mit der Konfiguration fortfahren
155
sas 24.1 156 === Konfiguration des Plugins ===
gru 4.1 157
158 Nachdem das Plugin installiert weurde, muss noch die Service-URL angepasst werden. Diese wird am Plugin über den Pflichtparameter {{code language="none"}}pdf.print.services.url{{/code}} festgelegt.
159
160 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.
161 Zum Beispiel: {{code language="none"}}http://localhost:8089/pdf{{/code}}
162
gru 4.2 163 Damit ist die Einrichtung des Print-Service Plugins abgeschlossen und steht als Aktion im Workflow zur Verfügung.
gru 4.1 164
sas 13.1 165 == Troubleshooting Installation ==
gru 4.1 166
sas 9.1 167 === Befehl npm wird nicht gefunden ===
sas 7.1 168
169 Unter Windows kann es sein, dass nach der NodeJS Installation die Umgebungsvariablen nicht richtig gesetzt werden und somit npm install nicht ausgeführt werden kann. Zu beobachten war dies auch, wenn nicht der Standardpfad unter C:/Programme bei NodeJS Installation verwendet wurde. Prüfen Sie also im Path, ob diese vorhanden sind. Folgendes ist hierfür zu tun:
170
171 * Aufruf der Umgebungsvariablen über Systemsteuerung > System > Erweiterte Systemeinstellungen > Button Umgebungsvariblen
172 * Unter Path sollten folgende Einträge zu finden sein: {{info}}C:\Users\{Nutzername}\AppData\Roaming\npm;C:\Program Files\nodejs{{/info}}
173 * Mit Ok bestätigen. Die Konsole muss anschließend mit Adminrechten neu geöffnet werden.
174
sas 9.1 175 === Befehl npm install führt zu Timeout ===
gru 4.1 176
177 Der Befehl npm install funktioniert aufgrund eines Proxys nicht, dann reicht die allgemeine Proxy-Einstellung nicht aus. Daher muss über Konsole folgendes ausgeführt werden:
178
179 {{code language="none"}}
180 npm config set proxy http://proxy.domain:port
181 npm config set https-proxy https://proxy.domain:port
182 {{/code}}
183
184 Falls Nutzerdaten erforderlich sind:
185
186 {{code language="none"}}
187 npm config set proxy http://user:pass@proxy.domain:port
188 npm config set https-proxy https://user:pass@proxy.domain:port
189 {{/code}}
190
191 Weitere Informationen sind auch hier zu finden: http://www.fladi.de/2014/02/06/howto-npm-hinter-einem-proxy-verwenden/
192
sas 9.1 193 === Druck funktioniert nicht ===
gru 4.1 194
195 Falls der Druck über FORMCYCLE nicht möglich ist, könnte die Ursache sein, dass der Print-Service nicht erreichbar ist. Dies kann durch die Loopback-URL behoben werden. Unter System > Allgemein > Loopback URL, Loopback Basis-URL: {{code language="none"}}http://localhost:<port>/formcycle{{/code}}
196
sas 9.1 197 === PDF wird gedruckt, aber es erscheint die Meldung 404 ===
gru 4.1 198
199 In dem Fall funktioniert der Print-Service korrekt, da bereits ein PDF erzeugt wird. Es muss geprüft werden, ob die Loopback-URL richtig eingetragen ist, damit die URL zum Print-Service richtig aufgelöst wird.
200
sas 9.1 201 === Download Chromium schlägt fehl ===
gru 4.1 202
203 Folgende Fehlermeldung erscheint auf der Konsole nach der Ausführung von „npm install“:
sas 5.1 204 {{code language="none"}}Error: unable to verify the first certificate{{/code}}
gru 4.1 205
206 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!
207
208 {{code language="none"}}
209 PS C:\test> $env:NODE_TLS_REJECT_UNAUTHORIZED = 0
210 PS C:\test> npm set strict-ssl false
211 {{/code}}
212
213 == Optionen der Plugin-Aktion ==
214
gru 4.2 215 Um das Plugin zu nutzen, klicken Sie im Workflow auf neue Aktion und wählen das Print-Plugin aus. Die folgenden Optionen werden zum Konfigurieren der Plugin-Aktion verwendet:
gru 1.1 216
sas 17.1 217 : Druck-Modus
awa 16.2 218 :; Formularfelder in Text umwandeln
219 :: Eingabefelder werden in Text umgewandelt und das Formular wird in der Breite entsprechend angepasst, siehe nächster Abschnitt.
220 :; Formularfelder bewahren
221 :: Das Formular wird so in dem PDF ausgegeben wie es auch im Browser aussieht.
sas 13.1 222
awa 15.1 223 ; Papiergröße
sas 14.1 224 : Angabe des Formats für das gedruckte Dokument.
sas 13.1 225
awa 15.1 226 ; Seitenausrichtung
sas 13.1 227 : Seiteausrichtung, welche für den Druck verwendet werden soll, Quer- und Hochformat sind möglich.
228
awa 15.1 229 ; Hintergrundbilder und Farben berücksichtigen
sas 13.1 230 : Hintergrundbilder und Farben werden nicht immer mit berücksichtigt, dies kann hiermit erzwungen werden.
231
awa 15.1 232 ; Blankodruck
awa 16.6 233 : (erfordert wenigstens Print-Plugin ab Version 4.2.0 und Print-Service ab Version 1.4.0) Wenn aktiviert, werden beim Druck alle Formularfelder geleert, alle versteckten Felder angezeigt. Zudem werden einige weitere Anpassungen für Blankodrücke vorgenommen, etwa wird die maximale Anzahl an Elementwiederholungen erzeugt.
awa 15.1 234
235 ; Formulartitel in der Kopfzeile anzeigen
sas 13.1 236 : Titel des Formulars im Kopfbereich des Dokumentes mitdrucken.
237
awa 15.1 238 ; Seitenzahlen in der Fußzeile anzeigen
sas 13.1 239 : Seitanzahl in des Fußzeile des Dokumentes mitdrucken.
240
awa 15.1 241 ; Datum in der Kopfzeile anzeigen
sas 13.1 242 : Aktuelle Daum im Kopfbereich des Dokumentes mitdrucken.
243
awa 15.1 244 ; Zoomfaktor
gru 1.1 245 : Faktor, um den das Formular vergrößert wird. Ist dieser kleiner 1, wird das Formular verkleinert. Kann genutzt werden, um besonders große oder kleine Formulare auf das A4-Format des PDF-Dokuments anzupassen.
sas 13.1 246
awa 15.1 247 ; Rand
sas 13.1 248 : Einstellungen für den Rand für oben, links, rechts und unten in Millimeter.
249
awa 15.1 250 ; Status beim Drucken
sas 13.1 251 : In Abhängigkeit von einem bestimmten Status drucken. Durch die Einstellungsmöglichkeit [[Verfügbar wenn>>doc:Formcycle.Designer.Form.ElementProperties.AvailableOnlyIf||target="_blank"]], können Formularelemente abhängig vom Status ausgeblendet werden und somit kann das Druckbild beeinflusst werden.
252
awa 15.1 253 ; Benutzergruppen
gru 1.1 254 : Benutzergruppen, denen der virtuelle Benutzer angehört, der das Formular über Selenium öffnet. Formularelemente können abhängig von der Benutzergruppe ausgeblendet bzw. //readonly// geschaltet werden.
sas 13.1 255
awa 15.1 256 ; URL-Parameter
gru 4.2 257 : Zusätzliche URL-Parameter, die an die URL angehängt werden, wenn das Formular über Selenium bei der Generierung des PDF-Dokuments geöffnet wird. Diese können beispielsweise genutzt werden, um [[Formularfelder vorzubefüllen>>Formcycle.Designer.Form.URLParameter]]. Auf diese URL-Parameter kann auch von selbstgeschriebenem JavaScript im Scriptbereich zugegriffen werden.
gru 1.1 258
awa 15.1 259 ; Timeout (in Sekunden)
sas 14.1 260 : Timout, bis der Druck abgebrochen wird, weil z.b. der Dienst nicht erreichbar ist. Die Standardeinstellung von 30 Sekunden zu ändern, kann dann sinnvoll sein, wenn die Last für den Druckprozessor erhöht ist um alle Anfragen abzuarbeiten.
sas 13.1 261
awa 15.1 262 ; Zeitpunkt für die PDF-Erstellung selbst bestimmen
sas 13.1 263 : Falls in einem selbst geschriebenen Java-Script verzögert Abfragen ausgeführt werden, dann kann mittels dem Parameter //window.print.status = true//, der Druck angestoßen werden. Dazu muss aber die Checkbox aktiviert werden. Sonst erfolgt der Druck sobald aus Sicht des Printers das Formular fertig geladen ist und Skripte ausgeführt wurden. Hierbei handelt es sich um eine fortgeschrittene Einstellung und sollte nur verwendet werden, wenn dies wirklich gebraucht wird.
264
awa 15.1 265 ; Dateiname
sas 13.1 266 : Dateiname, unter dem das erzeugte PDF-Dokument gespeichert wird.
awa 15.1 267
268 ; An den Vorgang anhängen
sas 13.1 269 : Die Datei dauerhaft speichern. Diese Einstellung ist auch notwendig, wenn die Datei z.B. auf einer Abschlussseite als Download (mittels [[Attachment-Platzhalter>>doc:Formcycle.UserInterface.Variables||anchor="HSystemplatzhalterfFCrHTML-Templates" target="_blank"]]) angeboten werden soll.
270
gru 4.1 271 == CSS-Anpassungen für Druckbild ==
sas 5.1 272
awa 16.2 273 Allgemeine CSS-Anpassungen für den Druck können über eine entsprechende Media-Query umgesetzt werden:
274
275 {{code language="css"}}
276 @media print {
277 /* general CSS for printing */
278 }
279 {{/code}}
280
281 Hier ist zu beachten, dass dieses CSS auch angwandt wird, wenn das Formular etwa direkt über den Browser gedruck wird.
282
283 Weiterhin gibt es speziell für den Print-Service noch folgende spezielle CSS-Klassen, welche immer an das //form.xm-form//-Element angefügt werden (erfordert mindestens Print-Plugin Version 4.2.0 und Print-Server-Plugin 1.4.0).
284
285 ; xm-print
286 : Wird immer angefügt.
awa 16.7 287 ; xm-print~-~-mode-plain
awa 16.2 288 : Wird angefügt, wenn als Druckmodus //Formularfelder bewahren// ausgewählt ist.
awa 16.7 289 ; xm-print~-~-mode-dynamic
awa 16.2 290 : Wird angefügt, wenn als Druckmodus //Formularfelder in Text umwandeln// ausgewählt ist.
awa 16.7 291 ; xm-print~-~-style-filled
awa 16.2 292 : Wird angefügt, wenn die Option //Blankodruck// deaktiviert ist.
awa 16.7 293 ; xm-print~-~-style-blank
awa 16.2 294 : Wird angefügt, wenn die Option //Blankodruck// aktiviert ist.
295
gru 4.1 296 === Textfelder und Auswahllisten ===
gru 1.1 297
awa 16.2 298 Zur Optimierung des PDF-Dokuments für den Druck werden Formularelemente vom Typ [[Eingabefeld>>Formcycle.Designer.Form.FormElements.Input]], [[Textarea>>Formcycle.Designer.Form.FormElements.Textarea]] und [[Auswahl>>Formcycle.Designer.Form.FormElements.Selection]] (Drop-Down) in reine Textfelder umgewandelt, falls als Druckmodus //Formularfelder in Text umwandeln// eingestellt ist. Zudem werden diese mit der CSS-Klasse //print// und //XSpan// versehen, welches für Anpassungen des Aussehens verwendet werden kann. Um etwas die Schriftgröße zu ändern, kann folgendes CSS verwendet werden:
gru 1.1 299
300 {{code language="css"}}
301 .print.XSpan {
sas 5.1 302 font-size: 18pt;
303 font-family: serif;
gru 1.1 304 }
305 {{/code}}
306
307 Um einige Eigenschaften des Standard-CSS zu überschreiben, welches mit {{formcycle/}} ausgeliefert wird, können spezifischerer Selektoren verwendet werden, wie beispielsweise
308
309 {{code language="css"}}
sas 3.1 310 .xm-form .xm-content div.print.XSpan {
gru 1.1 311 font-size: 18pt;
312 font-family: serif;
313 }
314 {{/code}}
315
316 Bei den meisten Eigenschaften ist dies jedoch nicht nötig.
317
gru 4.1 318 === Seitenumbruch erzwingen ===
gru 1.1 319
gru 4.1 320 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.
gru 1.1 321
gru 4.1 322 {{code language="css"}}
sas 5.1 323 [data-xn=div2] {
gru 4.1 324 display: block !important;
325 page-break-before: always;
326 }
327 {{/code}}
328
sas 5.1 329 === Seitenumbruch verhindern ===
330
331 Die Standardeinstellung beim Druck sieht vor, dass nach jeder Formularseite ein Umbruch eingefügt wird:
332
333 {{code language="css"}}
334 @media print {
335 .CXPage:not(:first-child ), .page-break {
336 display: block !important;
337 page-break-before: always;
338 }
339 }
340 {{/code}}
341
342 Um die Umbrüche zu vermeiden ist im Formularen folgende Regel im Reiter CSS zu hinterlegen:
343
344 {{code language="css"}}
345 @media print {
346 .CXPage:not(:first-child ) {
347 page-break-before: avoid;
348 }
349 }
350 {{/code}}
351
gru 4.1 352 === Verwendung von anderen Schriftarten ===
353
354 ==== Technische Voraussetzungen ====
355
sas 3.1 356 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.
357 {{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.
358 ##{{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}}
359
gru 4.1 360 ==== Einbinden im CSS ====
gru 1.1 361
362 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:
363
364 {{code language="css"}}
365 @media print {
366 @font-face {
367 font-family: 'DejaVu Sans';
368 src: local('DejaVu Sans');
369 }
370 .xm-form.modern *, .modern .XPage * {
371 font-family: "DejaVu Sans";
372 }
373 }
374 {{/code}}
375
376 Hierbei ist es insbesondere wichtig, dass die bei {{code language="none"}}local(){{/code}} eingetragene Bezeichung dem Namen der Schriftart entspricht.
377
gru 4.1 378 ==== Rechtliche Hinweise ====
gru 1.1 379
awa 16.1 380 Schriftarten haben zum Teil sehr eng umgrenzte Lizenzbedingungen und werden je nach Einsatzzweck unterschiedlich bepreist. Es ist zu beachten, dass Schriftarten für das Erstellen von PDFs in diese eingebettet werden müssen, was bei vielen kommerziellen Schriftarten eine andere Lizenz als für das Ausliefern über einen Webserver für den Zweck der Darstellung einer Webseite in einem Webbrowser verlangt.
gru 1.1 381
382 In Schriftarten vom Typ //TrueType// und //OpenType// können Informationen über die Einbettbarkeit der Schriftart direkt mitgespeichert werden. Je nachdem, was dort konfiguriert ist, kann eine Schriftart gegebenenfalls nicht eingebettet werden und wird vom //Print-Service-Plugin// stattdessen nur als Vektorgrafik in die erstellten PDF-Dokumente gerendert.
awa 16.1 383
sas 17.1 384 == JavaScript-Anpassungen für Druckbild ==
awa 16.4 385
386 Manchmal kann es erforderlich sein, vor dem Druck noch JavaScript auszuführen. Hierzu kann die Funktion //$.xutil.onPrint// verwendet werden, welche folgende Signatur hat
387
388 {{code language="text"}}
389 function onPrint(callback: () => Promise<void> | void): void
390 {{/code}}
391
392 Mit dieser Funktion können ein oder mehrere Callbacks registriert werden, welche vor dem Druck ausgeführt werden. Wenn ein Callback ein //Promise// zurückliefert, wird mit dem Druck gewartet, bis das Promise erfüllt ist. Falls das Promise abgewiesen wird, wird der Fehler gelogged, der Print aber nicht abgebrochen. Zu beachten ist weiterhin, dass die Registrierung der Callbacks vor dem Druck erfolgen muss, also beispielsweise innerhalb eines JQuery-Document-Ready-Handlers (//$(callback)//).
393
394 Falls beispielsweise ein AJAX-Request fertig ausgeführt werden soll, bevor mit dem Druck begonnen wird:
395
396 {{js}}
397 $.xutil.onPrint(async () => {
398 const response = await fetch("http://some-url.de");
399 // do something with response
400 });
401 {{/js}}
402
403 {{jsIE}}
404 $.xutil.onPrint(function() {
405 return new Promise(function(resolve, reject) {
406 $.ajax("http://some-url.de", {
407 success: function(data, textStatus, jqXHR) {
408 // Do something with the response data
409 resolve(undefined);
410 },
411 error: function(jqXHR, textStatus, errorThrown) {
412 reject("HTTP request error: " + textStatus + " - " + errorThrown);
413 },
414 });
415 });
416 });
417 {{/jsIE}}
418
sas 17.1 419 == Versionshistorie ==
awa 16.1 420
sas 17.1 421 === Plugin ===
awa 16.8 422
awa 26.2 423 ==== 4.3.0 ====
424
425 * Feature: Neue Option zum erneuten Versuchen des Drucks bei Fehlern.
426
sas 17.1 427 ==== 4.2.3 ====
awa 16.12 428
429 * Fix: Sonderzeichen im Wert von Auswahloptionen bei Combobox-Felder werden nun immer korrekt im Druck dargestellt.
430
sas 17.1 431 ==== 4.2.2 ====
awa 16.10 432
433 * Fix: Bei Textareas, wo die automatische Höhenanpassung aktiviert ist, wird vor dem Druck die Höhe noch einmal neu berechnet.
434
sas 17.1 435 ==== 4.2.1 ====
awa 16.9 436
awa 16.8 437 * Fix: Version des Print-Server beim Check wird korrekt angezeigt
438
sas 17.1 439 ==== 4.2.0 ====
awa 16.1 440
441 * Feature: Neue Option //Blankodruck// im Plugin
awa 16.5 442 * Feature: Es werden einige CSS-Klassen //xm-print// an das //form.xm-form// angefügt.
awa 16.1 443 * Change: Ist im Designer unter Print-Einstellungen (Word- und PDF-Export-Optionen) eingestellt, dass ein Element versteckt sein soll, wird dieses auch im Druck nicht mitgedruckt. FÜr dieses Features ist {{formcycle/}} Version 7.0.14 oder höher erforderlich.
444 * Change: Betrifft den Druckmodus //dynamisch//: Hatte ein Eingabefeld keinen Wert, wurde stattdessen der Platzhalter (placeholder-Attribute) des Elements als Wert angezeigt. Dies ist verwirrend und wurde geändert. Hat ein Eingabefeld keinen Wert, wird auch kein Wert dargestellt.
445 * Change: Betrifft den Druckmodus //dynamisch//: Hatte ein Auswahlfeld mit Darstellung Dropdown keinen Wert, wurde //Bitte auswählen// als Wert angezeigt. Dies wurde so geändert, dass nun kein Wert angezeigt wird.
446
sas 17.1 447 ==== 4.1.2 ====
awa 16.1 448
449 * Hinweis in der Plugin-Oberfläche bezüglich //$.xutil.onPrint// ergänzt.
450
sas 17.1 451 ==== 4.1.1 ====
awa 16.1 452
453 * Erfordert wenigstens {{formcycle/}} in Version 7.0.4.
454 * Change: Pflichtfeldhinweis wird nicht mehr angezeigt
455 * Fix: Datumformat wird wieder sofort eingeblendet
456
sas 17.1 457 ==== 4.1.0 ====
awa 16.1 458
459 * Status zum Drucken kann ausgewählt werden. Ist kein Status ausgewählt, wird wie bisher der aktuelle Status des Vorgangs genommen.
460 * Konfigurierte Nutzergruppen werden korrekt an der Aktion gespeichert.
461
sas 17.1 462 ==== 4.0.2 ====
awa 16.1 463
464 * Es kann nun ein Timeout gesetzt werden. Ist der Print-Service nicht erreichbar, wird die Aktion sonst möglicherweise nie abgebrochen.
465
sas 17.1 466 ==== 4.0.1 ====
awa 16.1 467
468 * Fix: In der Aktion für den neuen Workflow wurde die Datei nicht an den Vorgang angehangen.
469
sas 17.1 470 ==== 4.0.0 ====
awa 16.1 471
472 * Anpassungen für {{formcycle/}} Version 7.
473
sas 17.1 474 === Server ===
awa 16.1 475
sas 28.1 476 ==== 1.7.0 ====
awa 27.2 477
478 * Emuliere Media-Type print vor Druck und warte, bis kein Netzwerk-Traffic mehr herrscht. Hilft dabei, dass etwa Bilder aus @media-print-Regeln angezeigt werden.
479
awa 26.3 480 ==== 1.6.1 ====
awa 26.2 481
482 * Fix compatibility with Windows service installation script
483
awa 26.3 484 ==== 1.6.0 ====
awa 26.2 485
486 * Es wird nun Chromium 108.0.5351.0 zum Drucken genutzt.
awa 26.4 487 * Neues CLI-Flag //~-~-disableCache=true// zum Deaktivieren des Browser-Cache.
488 * Neues CLI-Flag //~-~-isolatedBrowser=true// um einen separaten Browser für jeden Print-Request zu verwenden.
awa 26.2 489 * Fix Debian Install-Script, installiere auch libgbm1.
490
sas 17.1 491 ==== 1.5.1 ====
awa 16.11 492
493 * Abhängigkeit node-windows aktualisiert
494
sas 17.1 495 ==== 1.5.0 ====
awa 16.1 496
awa 16.9 497 * Update auf Chromium 105.0.5173.0
498 * Erfordert mindestens Node.JS 14 oder höher
awa 16.1 499
sas 17.1 500 ==== 1.4.1 ====
awa 16.1 501
awa 16.9 502 * Script zum Installieren / Deinstallieren des Windows-Services ist wieder lauffähig (//install-windows-service.js// und //uninstall-windows-service.js//)
awa 16.1 503
sas 17.1 504 ==== 1.4.0 ====
awa 16.1 505
awa 16.9 506 * Bei Fehlern während des Druckens wird dieser Fehler mit der HTTP-Antwort zurückgeliefert
507 * Print-Server kann nun zum Drucken beliebiger Webseiten genutzt werden. JavaScript und CSS, welche im Kontext der zu druckenden Seite ausgeführt werden soll, kann nun mit der HTTP-Anfrage übergeben werden.
sas 17.1 508 * Bei Aufruf des Pfads ///pdf// liefer der Print-Server nun eine Status-Report des Servers zurück.