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