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
58 === Aktualisierung ===
59
60 Prinzipiell ist eine Aktualisierung möglich, indem der Print-Service deinstalliert und anschließend neu installiert wird.
61
62 In den meisten Fällen reicht es allerdings aus, die Server-Script-Dateien zu ersetzen und die Abhängigkeiten per npm zu aktualsieren:
63
64 * Die aktuelle Version "print_server_fc.zip" herunterladen.
65 * Den Print-Service-Windows-Dienst stoppen.
66 * 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).
67 * Wichtig: Der Ordner {{code language="none"}}daemon{{/code}} und die darin enthaltenen Dateien sollten dabei nicht geändert werden!
68 * Eine Window-Kommandozeile öffnen und in den Ordner wechseln, wohin die Dateien kopiert wurden.
69 * 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.
70 * Nun kann der Print-Service-Windows-Dienst wieder gestartet werden.
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
95 # Installation starten
96 ./install_print_server.sh
97
98
99 # Print Server ausführen
100 systemctl start printserver
101 {{/code}}
102
103 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.
104 Ü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.
105
106 ==== Deinstallation ====
107
108 Für die Deinstallation des Print Servers, öffnen Sie eine Kommandozeile (cmd) mit administrativen Berechtigungen und führen Sie folgende Befehle aus:
109
110 {{code language="none"}}
111 /home/formcycle/deinstall_printserver.sh
112 {{/code}}
113
114 {{info}}
115 **Achtung:**
116 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!
117 {{/info}}
118
119 === Aktualisierung ===
120
121 Prinzipiell ist eine Aktualisierung möglich, indem der Print-Service deinstalliert und anschließend neu installiert wird.
122
123 In den meisten Fällen reicht es allerdings aus, die Server-Script-Dateien zu ersetzen und die Abhängigkeiten per npm zu aktualsieren:
124
125 * Die aktuelle Version "print_server_fc.zip" herunterladen.
126 * Den Print-Service-Systemdienst stoppen.
127 * 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).
128 * In der Kommandozeile in den Ordner wechseln, wohin die Dateien kopiert wurden.
129 * 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.
130 * Nun kann der Print-Service-Systemdienst wieder gestartet werden.
131
132 === Test ===
133
134 Um zu prüfen, ob die Installation erfolgreich durchgeführt wurde, kann der Service testweise auf dem Server aufgerufen werden:
135 {{code language="none"}}http://localhost:8090/pdf?orientation=landscape&format=A4&wait=false&marginTop=0mm&formURL=http://www.formcycle.de{{/code}}
136
137 === Einrichtung des Plugins ===
138
139 ==== Installation Plugin Print-Service ====
140
141 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]].
142
143 Falls bereits die alte Version des Print-Service Plugins (Phantom-Plugin) installiert war, wird folgende Vorgehensweise für die Installation empfohlen:
144
145 * Phantom-Plugin deaktivieren
146 * Phantom-Plugin löschen
147 * Neues Print-Service Plugin hochladen
148 * Mit der Konfiguration fortfahren
149
150 ==== Konfiguration des Plugins ====
151
152 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.
153
154 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.
155 Zum Beispiel: {{code language="none"}}http://localhost:8089/pdf{{/code}}
156
157 Damit ist die Einrichtung des Print-Service Plugins abgeschlossen und steht als Aktion im Workflow zur Verfügung.
158
159 === Troubleshooting ===
160
161 ==== Befehl npm install führt zu Timeout ====
162
163 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:
164
165 {{code language="none"}}
166 npm config set proxy http://proxy.domain:port
167 npm config set https-proxy https://proxy.domain:port
168 {{/code}}
169
170 Falls Nutzerdaten erforderlich sind:
171
172 {{code language="none"}}
173 npm config set proxy http://user:pass@proxy.domain:port
174 npm config set https-proxy https://user:pass@proxy.domain:port
175 {{/code}}
176
177 Weitere Informationen sind auch hier zu finden: http://www.fladi.de/2014/02/06/howto-npm-hinter-einem-proxy-verwenden/
178
179 ==== Druck funktioniert nicht ====
180
181 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}}
182
183 ==== PDF wird gedruckt, aber es erscheint die Meldung 404 ====
184
185 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.
186
187 ==== Download Chromium schlägt fehl ====
188
189 Folgende Fehlermeldung erscheint auf der Konsole nach der Ausführung von „npm install“:
190 {{code language="none"}}Error: unable to verify the first certificate{{/code}}
191
192 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!
193
194 {{code language="none"}}
195 PS C:\test> $env:NODE_TLS_REJECT_UNAUTHORIZED = 0
196 PS C:\test> npm set strict-ssl false
197 {{/code}}
198
199 == Optionen der Plugin-Aktion ==
200
201 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:
202
203 ; **Dateiname**
204 : Dateiname, unter dem das erzeugte PDF-Dokument gespeichert wird.
205 ; **Druckmodus Formular mit textueller Ausgabe von Werten**
206 : Eingabefelder werden in Text umgewandelt und das Formular wird in der Breite entsprechend angepasst, siehe nächster Abschnitt.
207 ; **Druckmodus Formular mit Eingabefeldern**
208 : Das Formular wird so in dem PDF ausgegeben wie es auch im Browser aussieht.
209 ; **Zoomfaktor**
210 : 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.
211 ; **Benutzergruppen**
212 : 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.
213 ; **URL-Parameter**
214 : 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.
215
216 == CSS-Anpassungen für Druckbild ==
217
218 === Textfelder und Auswahllisten ===
219
220 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 Formular mit textueller Ausgabe von Werten** 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:
221
222 {{code language="css"}}
223 .print.XSpan {
224 font-size: 18pt;
225 font-family: serif;
226 }
227 {{/code}}
228
229 Um einige Eigenschaften des Standard-CSS zu überschreiben, welches mit {{formcycle/}} ausgeliefert wird, können spezifischerer Selektoren verwendet werden, wie beispielsweise
230
231 {{code language="css"}}
232 .xm-form .xm-content div.print.XSpan {
233 font-size: 18pt;
234 font-family: serif;
235 }
236 {{/code}}
237
238 Bei den meisten Eigenschaften ist dies jedoch nicht nötig.
239
240 === Seitenumbruch erzwingen ===
241
242 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.
243
244 {{code language="css"}}
245 [data-xn=div2] {
246 display: block !important;
247 page-break-before: always;
248 }
249 {{/code}}
250
251 === Seitenumbruch verhindern ===
252
253 Die Standardeinstellung beim Druck sieht vor, dass nach jeder Formularseite ein Umbruch eingefügt wird:
254
255 {{code language="css"}}
256 @media print {
257 .CXPage:not(:first-child ), .page-break {
258 display: block !important;
259 page-break-before: always;
260 }
261 }
262 {{/code}}
263
264 Um die Umbrüche zu vermeiden ist im Formularen folgende Regel im Reiter CSS zu hinterlegen:
265
266 {{code language="css"}}
267 @media print {
268 .CXPage:not(:first-child ) {
269 page-break-before: avoid;
270 }
271 }
272 {{/code}}
273
274 === Verwendung von anderen Schriftarten ===
275
276 ==== Technische Voraussetzungen ====
277
278 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.
279 {{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.
280 ##{{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}}
281
282 ==== Einbinden im CSS ====
283
284 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:
285
286 {{code language="css"}}
287 @media print {
288 @font-face {
289 font-family: 'DejaVu Sans';
290 src: local('DejaVu Sans');
291 }
292 .xm-form.modern *, .modern .XPage * {
293 font-family: "DejaVu Sans";
294 }
295 }
296 {{/code}}
297
298 Hierbei ist es insbesondere wichtig, dass die bei {{code language="none"}}local(){{/code}} eingetragene Bezeichung dem Namen der Schriftart entspricht.
299
300 ==== Rechtliche Hinweise ====
301
302 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.
303
304 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.