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 Das Print-Service Plugin wurde aus technischen Gründen auf ein neues Konzept umgestellt. Hierfür muss neben dem Plugin ein eigener Print-Server installiert werden.
5
6 Die Benutzung und Konfiguration der Plugin-Aktion unterscheidet sich zwischen der alten und der neuen Version nicht. Hinweise zu Besonderheiten und zur Installation sowie die Downloadlink zur alten Version befinden sich im Punkt [[Hinweise für ältere Versionen des Print-Service Plugins>>||anchor="HHinweisefFCrE4ltereVersionendesPrint-ServicePlugins"]].
7 {{/info}}
8
9 {{content/}}
10
11 Das kostenpflichtige Plugin //Print-Service// ermöglicht es, in der Statusverarbeitung ein PDF aus dem Formular zu erzeugen, welches besser für den Druck geeignet ist.
12
13 == Technische Besonderheiten ==
14
15 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.
16
17 == Installation ==
18
19 Die Installation des benötigten //Print Servers// erfordert je nach Betriebssystem unterschiedlicher Vorgehensweisen.
20
21 === Installation Print Server unter Windows ===
22
23 ==== Installation von Node.js ====
24
25 : 1. Download der LTS-Version unter https://nodejs.org/
26 : 2. MSI-Datei ausführen
27 : 3. Wizard-Schritte durchlaufen, wobei die Standardeinstellungen so belassen werden können
28
29 ==== Installationsschritte für den Print Server ====
30
31 : 4. Die Print Server Installationsdateien können Sie hier über die Customer-Cloud herunterladen.
32 : 5. Entpacken Sie die ZIP Datei „print_server_fc.zip“ und verschieben Sie den Inhalt in den Ordner print_server_fc unter C:\Programme\.
33 : 6. Zur Installation öffnen Sie die Kommandozeile (cmd) mit administrativen Berechtigungen und führen die folgenden Befehle aus:
34
35 {{code language="none"}}
36 cd C:\Programme\print_server_fc
37 npm install
38 npm install -g node-windows
39 npm link node-windows
40 node install-windows-service.js
41 {{/code}}
42
43 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 durchführen.
44 Das Skript install-windows-service.js 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 --port=8090 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 Nach der Installation wird ein Ordner mit dem Namen „deamon“ für die Logdateien angelegt.
49
50 ==== Deinstallation ====
51
52 Für die Deinstallation des Print Servers, öffnen Sie eine Kommandozeile (cmd) mit administrativen Berechtigungen und führen Sie folgende Befehle aus.
53
54 {{code language="none"}}
55 cd C:\Programme\print_server_fc
56 node uninstall-windows-service.js
57 {{/code}}
58
59
60 === Installation Print Server unter Linux ===
61
62 ==== Installationsschritte für die Installation von Node.js und dem Print Server ====
63
64 Zur Installation öffnen Sie die Konsole und führen die folgenden Befehle aus:
65
66 {{code language="none"}}
67 # Laden des Skriptes (je nach Betriebssystem unterschiedlich)
68
69 # Debian 10 - Wenn Sie als root angemeldet sind:
70 wget "https://customer.formcycle.eu/index.php/s/0GBtp1HtQHJMzQx/download?path=/&files=install_printserver_debian10.sh" -O install_print_server.sh
71
72 # Debian 10 - oder wenn Sie als normaler Benutzer mit Sudo-Rechten angemeldet sind:
73 wget "https://customer.formcycle.eu/index.php/s/0GBtp1HtQHJMzQx/download?path=/&files=install_printserver_debian10_sudo.sh" -O install_print_server.sh
74
75 # Ubuntu 16 - Wenn Sie als root angemeldet sind:
76 wget "https://customer.formcycle.eu/index.php/s/0GBtp1HtQHJMzQx/download?path=/&files=install_printserver_ubuntu16.sh" -O install_print_server.sh
77
78 # Datei Ausführbar machen
79 chmod 750 install_print_server.sh
80
81 # Installation starten
82 ./install_print_server.sh
83
84 # Print Server ausführen
85 systemctl start printserver
86 {{/code}}
87
88 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.
89 Ü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.
90
91 ==== Deinstallation ====
92
93 Für die Deinstallation des Print Servers, öffnen Sie eine Kommandozeile (cmd) mit administrativen Berechtigungen und führen Sie folgende Befehle aus:
94
95 {{code language="none"}}
96 /home/formcycle/deinstall_printserver.sh
97 {{/code}}
98
99 {{info}}
100 **Achtung:**
101 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!
102 {{/info}}
103
104 === Test ===
105
106 Um zu prüfen, ob die Installation erfolgreich durchgeführt wurde, kann der Service testweise auf dem Server aufgerufen werden:
107 http://localhost:8090/pdf?orientation=landscape&format=A4&wait=false&marginTop=0mm&formURL=http://www.formcycle.de
108
109 === Einrichtung des Plugins ===
110 ==== Installation Plugin Print-Service ====
111
112 Damit das Plugin in {{formcycle/}} als Aktion in der Verarbeitung 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]].
113
114 Falls bereits die alte Version des Print-Service Plugins (Phantom-Plugin) installiert war, wird folgende Vorgehensweise für die Installation empfohlen:
115 : Phantom-Plugin deaktivieren
116 : Phantom-Plugin löschen
117 : Neues Print-Service Plugin hochladen
118 : Mit der Konfiguration fortfahren
119
120 ==== Konfiguration des Plugins ====
121
122 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.
123
124 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.
125 Zum Beispiel: {{code language="none"}}http://localhost:8089/pdf{{/code}}
126
127 Damit ist die Einrichtung des Print-Service Plugins abgeschlossen und steht als Aktion in der Verarbeitung zur Verfügung.
128
129 === Troubleshooting ===
130
131 ==== Befehl npm install führt zu Timeout ====
132
133 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:
134
135 {{code language="none"}}
136 npm config set proxy http://proxy.domain:port
137 npm config set https-proxy https://proxy.domain:port
138 {{/code}}
139
140 Falls Nutzerdaten erforderlich sind:
141
142 {{code language="none"}}
143 npm config set proxy http://user:pass@proxy.domain:port
144 npm config set https-proxy https://user:pass@proxy.domain:port
145 {{/code}}
146
147 Weitere Informationen sind auch hier zu finden: http://www.fladi.de/2014/02/06/howto-npm-hinter-einem-proxy-verwenden/
148
149 ==== Druck funktioniert nicht ====
150
151 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}}
152
153 ==== PDF wird gedruckt, aber es erscheint die Meldung 404 ====
154
155 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.
156
157 ==== Download Chromium schlägt fehl ====
158
159 Folgende Fehlermeldung erscheint auf der Konsole nach der Ausführung von „npm install“:
160 {{code language="none"}}
161 Error: unable to verify the first certificate
162 {{/code}}
163 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!
164
165 {{code language="none"}}
166 PS C:\test> $env:NODE_TLS_REJECT_UNAUTHORIZED = 0
167 PS C:\test> npm set strict-ssl false
168 {{/code}}
169
170 == Optionen der Plugin-Aktion ==
171
172 Um das Plugin zu nutzen, klicken Sie in der Statusverarbeitung auf neue Aktion und wählen das Print-Plugin aus. Die folgenden Optionen werden zum Konfigurieren der Plugin-Aktion verwendet:
173
174 ; **Dateiname**
175 : Dateiname, unter dem das erzeugte PDF-Dokument gespeichert wird.
176 ; **Druckmodus Formular mit textueller Ausgabe von Werten**
177 : Eingabefelder werden in Text umgewandelt und das Formular wird in der Breite entsprechend angepasst, siehe nächster Abschnitt.
178 ; **Druckmodus Formular mit Eingabefeldern**
179 : Das Formular wird so in dem PDF ausgegeben wie es auch im Browser aussieht.
180 ; **Zoomfaktor**
181 : 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.
182 ; **Benutzergruppen**
183 : 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.
184 ; **URL-Parameter**
185 : 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.FormDesigner.URLParameter]]. Auf diese URL-Parameter kann auch von selbstgeschriebenem JavaScript im Scriptbereich zugegriffen werden.
186
187 == CSS-Anpassungen für Druckbild ==
188 === Textfelder und Auswahllisten ===
189
190 Zur Optimierung des PDF-Dokuments für den Druck werden Formularelemente vom Typ [[Eingabefeld>>Formcycle.FormDesigner.FormElements.Input]], [[Textarea>>Formcycle.FormDesigner.FormElements.Textarea]] und [[Auswahl>>Formcycle.FormDesigner.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:
191
192 {{code language="css"}}
193 .print.XSpan {
194 font-size: 18pt;
195 font-family: serif;
196 }
197 {{/code}}
198
199 Um einige Eigenschaften des Standard-CSS zu überschreiben, welches mit {{formcycle/}} ausgeliefert wird, können spezifischerer Selektoren verwendet werden, wie beispielsweise
200
201 {{code language="css"}}
202 .xm-form .xm-content div.print.XSpan {
203 font-size: 18pt;
204 font-family: serif;
205 }
206 {{/code}}
207
208 Bei den meisten Eigenschaften ist dies jedoch nicht nötig.
209
210 === Seitenumbruch erzwingen ===
211
212 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.
213
214 {{code language="css"}}
215 [xn=div2] {
216 display: block !important;
217 page-break-before: always;
218 }
219 {{/code}}
220
221 === Verwendung von anderen Schriftarten ===
222
223 ==== Technische Voraussetzungen ====
224
225 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.
226 {{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.
227 ##{{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}}
228
229 ==== Einbinden im CSS ====
230
231 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:
232
233 {{code language="css"}}
234 @media print {
235 @font-face {
236 font-family: 'DejaVu Sans';
237 src: local('DejaVu Sans');
238 }
239 .xm-form.modern *, .modern .XPage * {
240 font-family: "DejaVu Sans";
241 }
242 }
243 {{/code}}
244
245 Hierbei ist es insbesondere wichtig, dass die bei {{code language="none"}}local(){{/code}} eingetragene Bezeichung dem Namen der Schriftart entspricht.
246
247 ==== Rechtliche Hinweise ====
248
249 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.
250
251 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.
252
253 == Hinweise für ältere Versionen des Print-Service Plugins ==
254
255 Die folgenden Hinweise beziehen sich auf die alte Version des Print-Service Plugins, welche auf //phantomJS// basiert.
256
257 [[**Plugin-Download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/plugin-bundle-phantomjs&fileid=342||rel="noopener noreferrer" target="_blank"]] (erfordert Anmeldung)
258
259 {{info}}
260 Bitte verwenden Sie für {{formcycle/}} Version 6 das Plugin ab **Version 2.0.0**.
261 {{/info}}
262
263 === Installation ===
264
265 Das Plugin kann als Mandant-Plugin oder System-Plugin installiert werden. Eine Anleitung zur Installation von Plugins finden Sie [[hier>>doc:Formcycle.UserInterface.Client.Plugins.WebHome]].
266
267 {{info}}
268 Es existieren mehrere Versionen des Print-Service Plugins für verschiedne Betriebssysteme (//32-Bit Linux//, //64-Bit Linux//, //Windows//, //MacOSX//). Es muss nur die Version des Plugin installiert werden, welche dem Betriebssystem entspricht, auf dem {{formcycle/}} installiert ist. Die Betriebssystemart wird auf der Seite [[Serverinformation>>Formcycle.SystemSettings.UserInterface.ServerInformation]] angezeigt.
269 {{/info}}
270
271 === Technische Besonderheiten ===
272
273 Technisch erfolgt die Umsetzung mittels Selenium und dem Treiber //phantomJS//. Das PDF-Dokument wird im Format A4 erzeugt.
274
275 {{warning}}
276 Beim Drucken mit dem Print-Service wird JavaScript aus dem Formular ausgeführt. Hierbei muss allerdings beachtet werden, dass hierbei keine neuen JavaScript-Funktionen zur Verfügung stehen. Konkret werden keine Funktionalitäten ab {{smallcaps}}Ecma{{/smallcaps}}Script6 und höher unterstützt. Es können also etwa keine neuen Schlüsselwörter wie //let// und //const// oder neue Syntax wie Arrow-Funktionen oder Destrukturierung verwendet werden.
277 {{/warning}}

Navigation

Copyright 2000-2025