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"}}deamon{{/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 === Installation Print Server unter Linux ===
59
60 ==== Installationsschritte für die Installation von Node.js und dem Print Server ====
61
62 Zur Installation öffnen Sie die Konsole und führen die folgenden Befehle aus:
63
64 {{code language="none"}}
65 # Laden des Skriptes (je nach Betriebssystem unterschiedlich)
66
67 # Debian 10 - Wenn Sie als root angemeldet sind:
68 wget "https://customer.formcycle.eu/index.php/s/0GBtp1HtQHJMzQx/download?path=/&files=install_printserver_debian10.sh" -O install_print_server.sh
69
70 # Debian 10 - oder wenn Sie als normaler Benutzer mit Sudo-Rechten angemeldet sind:
71 wget "https://customer.formcycle.eu/index.php/s/0GBtp1HtQHJMzQx/download?path=/&files=install_printserver_debian10_sudo.sh" -O install_print_server.sh
72
73 # Ubuntu 16 - Wenn Sie als root angemeldet sind:
74 wget "https://customer.formcycle.eu/index.php/s/0GBtp1HtQHJMzQx/download?path=/&files=install_printserver_ubuntu16.sh" -O install_print_server.sh
75
76
77 # Datei Ausführbar machen
78 chmod 750 install_print_server.sh
79
80
81 # Installation starten
82 ./install_print_server.sh
83
84
85 # Print Server ausführen
86 systemctl start printserver
87 {{/code}}
88
89 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.
90 Ü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.
91
92 ==== Deinstallation ====
93
94 Für die Deinstallation des Print Servers, öffnen Sie eine Kommandozeile (cmd) mit administrativen Berechtigungen und führen Sie folgende Befehle aus:
95
96 {{code language="none"}}
97 /home/formcycle/deinstall_printserver.sh
98 {{/code}}
99
100 {{info}}
101 **Achtung:**
102 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!
103 {{/info}}
104
105 === Test ===
106
107 Um zu prüfen, ob die Installation erfolgreich durchgeführt wurde, kann der Service testweise auf dem Server aufgerufen werden:
108 {{code language="none"}}http://localhost:8090/pdf?orientation=landscape&format=A4&wait=false&marginTop=0mm&formURL=http://www.formcycle.de{{/code}}
109
110 === Einrichtung des Plugins ===
111
112 ==== Installation Plugin Print-Service ====
113
114 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]].
115
116 Falls bereits die alte Version des Print-Service Plugins (Phantom-Plugin) installiert war, wird folgende Vorgehensweise für die Installation empfohlen:
117 * Phantom-Plugin deaktivieren
118 * Phantom-Plugin löschen
119 * Neues Print-Service Plugin hochladen
120 * Mit der Konfiguration fortfahren
121
122 ==== Konfiguration des Plugins ====
123
124 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.
125
126 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.
127 Zum Beispiel: {{code language="none"}}http://localhost:8089/pdf{{/code}}
128
129 Damit ist die Einrichtung des Print-Service Plugins abgeschlossen und steht als Aktion im Workflow zur Verfügung.
130
131 === Troubleshooting ===
132
133 ==== Befehl npm install führt zu Timeout ====
134
135 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:
136
137 {{code language="none"}}
138 npm config set proxy http://proxy.domain:port
139 npm config set https-proxy https://proxy.domain:port
140 {{/code}}
141
142 Falls Nutzerdaten erforderlich sind:
143
144 {{code language="none"}}
145 npm config set proxy http://user:pass@proxy.domain:port
146 npm config set https-proxy https://user:pass@proxy.domain:port
147 {{/code}}
148
149 Weitere Informationen sind auch hier zu finden: http://www.fladi.de/2014/02/06/howto-npm-hinter-einem-proxy-verwenden/
150
151 ==== Druck funktioniert nicht ====
152
153 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}}
154
155 ==== PDF wird gedruckt, aber es erscheint die Meldung 404 ====
156
157 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.
158
159 ==== Download Chromium schlägt fehl ====
160
161 Folgende Fehlermeldung erscheint auf der Konsole nach der Ausführung von „npm install“:
162 {{code language="none"}}
163 Error: unable to verify the first certificate
164 {{/code}}
165
166 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!
167
168 {{code language="none"}}
169 PS C:\test> $env:NODE_TLS_REJECT_UNAUTHORIZED = 0
170 PS C:\test> npm set strict-ssl false
171 {{/code}}
172
173 == Optionen der Plugin-Aktion ==
174
175 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:
176
177 ; **Dateiname**
178 : Dateiname, unter dem das erzeugte PDF-Dokument gespeichert wird.
179 ; **Druckmodus Formular mit textueller Ausgabe von Werten**
180 : Eingabefelder werden in Text umgewandelt und das Formular wird in der Breite entsprechend angepasst, siehe nächster Abschnitt.
181 ; **Druckmodus Formular mit Eingabefeldern**
182 : Das Formular wird so in dem PDF ausgegeben wie es auch im Browser aussieht.
183 ; **Zoomfaktor**
184 : 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.
185 ; **Benutzergruppen**
186 : 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.
187 ; **URL-Parameter**
188 : 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.
189
190 == CSS-Anpassungen für Druckbild ==
191 === Textfelder und Auswahllisten ===
192
193 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:
194
195 {{code language="css"}}
196 .print.XSpan {
197 font-size: 18pt;
198 font-family: serif;
199 }
200 {{/code}}
201
202 Um einige Eigenschaften des Standard-CSS zu überschreiben, welches mit {{formcycle/}} ausgeliefert wird, können spezifischerer Selektoren verwendet werden, wie beispielsweise
203
204 {{code language="css"}}
205 .xm-form .xm-content div.print.XSpan {
206 font-size: 18pt;
207 font-family: serif;
208 }
209 {{/code}}
210
211 Bei den meisten Eigenschaften ist dies jedoch nicht nötig.
212
213 === Seitenumbruch erzwingen ===
214
215 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.
216
217 {{code language="css"}}
218 [xn=div2] {
219 display: block !important;
220 page-break-before: always;
221 }
222 {{/code}}
223
224 === Verwendung von anderen Schriftarten ===
225
226 ==== Technische Voraussetzungen ====
227
228 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.
229 {{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.
230 ##{{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}}
231
232 ==== Einbinden im CSS ====
233
234 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:
235
236 {{code language="css"}}
237 @media print {
238 @font-face {
239 font-family: 'DejaVu Sans';
240 src: local('DejaVu Sans');
241 }
242 .xm-form.modern *, .modern .XPage * {
243 font-family: "DejaVu Sans";
244 }
245 }
246 {{/code}}
247
248 Hierbei ist es insbesondere wichtig, dass die bei {{code language="none"}}local(){{/code}} eingetragene Bezeichung dem Namen der Schriftart entspricht.
249
250 ==== Rechtliche Hinweise ====
251
252 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.
253
254 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.