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