Änderungen von Dokument Print-Service-Plugin

Von 10.1 nach 9.1 Von 26.4 nach 26.3

Von Version 26.3

bearbeitet von awa
am 29.11.2022, 13:40

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Auf Version 10.1

bearbeitet von sas
am 02.03.2022, 14:54

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (2 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Dokument-Autor

@@ -1,1 +1,1 @@
--XWiki.awa
++XWiki.sas

Inhalt

@@ -12,17 +12,19 @@
  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.
--== Installation Print Server unter Windows ==
++== Installation ==
  Die Installation des benötigten //Print Servers// erfordert je nach Betriebssystem unterschiedlicher Vorgehensweisen.
--=== Installation von Node.js ===
++=== Installation Print Server unter Windows ===
++==== Installation von Node.js ====
++
  : 1. Download der LTS-Version unter https://nodejs.org/
  : 2. MSI-Datei ausführen
  : 3. Wizard-Schritte durchlaufen, wobei die Standardeinstellungen so belassen werden können
--=== Installationsschritte für den Print Server ===
++==== Installationsschritte für den Print Server ====
  : 4. Die Print Server Installationsdateien können Sie hier über die Customer-Cloud herunterladen.
  : 5. Entpacken Sie die ZIP Datei „print_server_fc.zip“ und verschieben Sie den Inhalt in den Ordner print_server_fc unter C:\Programme\.
@@ -62,17 +62,14 @@
  * Den Print-Service-Windows-Dienst stoppen.
  * 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).
  * Wichtig: Der Ordner {{code language="none"}}daemon{{/code}} und die darin enthaltenen Dateien sollten dabei nicht geändert werden!
--* Eine Window-Kommandozeile (cmd) mit administrativen Berechtigungen öffnen
--* In den //print_server_fc// Ordner wechseln, wohin die Dateien kopiert wurden.
--* 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 eine Verbindung nicht möglich ist, schaue Sie bitte [[hier>>doc:||anchor="HBefehlnpminstallfFChrtzuTimeout"]].
++* Eine Window-Kommandozeile (cmd) mit administrativen Berechtigungen öffnen und in den Ordner wechseln, wohin die Dateien kopiert wurden.
++* 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.
  * Nun kann der Print-Service-Windows-Dienst wieder gestartet werden.
--Sollt das Update dazu führen, dass der Dienst nicht mehr gestartet werden kann, sollten Sie eine Neuinstallation durchfürhen. Heißt erst eine Deinstallation und dann den Schritten unter Installation folgen.
++=== Installation Print Server unter Linux ===
--== Installation Print Server unter Linux ==
++==== Installationsschritte für die Installation von Node.js und dem Print Server ====
--=== Installationsschritte für die Installation von Node.js und dem Print Server ===
--
  Zur Installation öffnen Sie die Konsole und führen die folgenden Befehle aus:
  {{code language="none"}}
@@ -121,24 +121,21 @@
  In den meisten Fällen reicht es allerdings aus, die Server-Script-Dateien zu ersetzen und die Abhängigkeiten per npm zu aktualsieren:
  * Die aktuelle Version "print_server_fc.zip" herunterladen.
--* Den Print-Service-Systemdienst FORMCYCLE Print Sever stoppen: {{code language="none"}}systemctl stop printserver{{/code}}
--* 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 überschreiben" auswählen).
--* Eine Kommandozeile (cmd) mit administrativen Berechtigungen öffnen und in den Ordner wechseln, wohin die Dateien kopiert wurden. Di Dateien sollten standardmäßig unter (% id="cke_bm_219S" style="display:none" %) (%%) {{code language="none"}}/home/formcycle/print_server{{/code}} zu finden sein.
++* Den Print-Service-Systemdienst stoppen.
++* 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).
++* In der Kommandozeile in den Ordner wechseln, wohin die Dateien kopiert wurden.
  * 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.
--* Nun kann der Print-Service-Systemdienst wieder gestartet werden: {{code language="none"}}systemctl start printserver{{/code}}
++* Nun kann der Print-Service-Systemdienst wieder gestartet werden.
--== Test ==
++=== Test ===
--Um zu prüfen, ob die Installation erfolgreich durchgeführt wurde, kann der Service testweise auf dem localen Server aufgerufen werden (in diesem Beispiel wird versucht die Webseite formcycle.de zu drucken):
++Um zu prüfen, ob die Installation erfolgreich durchgeführt wurde, kann der Service testweise auf dem Server aufgerufen werden:
++{{code language="none"}}http://localhost:8090/pdf?orientation=landscape&format=A4&wait=false&marginTop=0mm&formURL=http://www.formcycle.de{{/code}}
--{{code language="none"}}
--http://localhost:8090/pdf?orientation=landscape&format=A4&wait=false&marginTop=0mm&formURL=http://www.formcycle.de
--{{/code}}
++=== Einrichtung des Plugins ===
--== Einrichtung des Plugins ==
++==== Installation Plugin Print-Service ====
--=== Installation Plugin Print-Service ===
--
  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]].
  Falls bereits die alte Version des Print-Service Plugins (Phantom-Plugin) installiert war, wird folgende Vorgehensweise für die Installation empfohlen:
@@ -148,7 +148,7 @@
  * Neues Print-Service Plugin hochladen
  * Mit der Konfiguration fortfahren
--=== Konfiguration des Plugins ===
++==== Konfiguration des Plugins ====
  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.
@@ -157,7 +157,7 @@
  Damit ist die Einrichtung des Print-Service Plugins abgeschlossen und steht als Aktion im Workflow zur Verfügung.
--== Troubleshooting Installation ==
++== Troubleshooting ==
  === Befehl npm wird nicht gefunden ===
@@ -209,88 +209,24 @@
  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:
--: Druck-Modus
--:; Formularfelder in Text umwandeln
--:: Eingabefelder werden in Text umgewandelt und das Formular wird in der Breite entsprechend angepasst, siehe nächster Abschnitt.
--:; Formularfelder bewahren
--:: Das Formular wird so in dem PDF ausgegeben wie es auch im Browser aussieht.
--
--; Papiergröße
--: Angabe des Formats für das gedruckte Dokument.
--
--; Seitenausrichtung
--: Seiteausrichtung, welche für den Druck verwendet werden soll, Quer- und Hochformat sind möglich.
--
--; Hintergrundbilder und Farben berücksichtigen
--: Hintergrundbilder und Farben werden nicht immer mit berücksichtigt, dies kann hiermit erzwungen werden.
--
--; Blankodruck
--: (erfordert wenigstens Print-Plugin ab Version 4.2.0 und Print-Service ab Version 1.4.0) Wenn aktiviert, werden beim Druck alle Formularfelder geleert, alle versteckten Felder angezeigt. Zudem werden einige weitere Anpassungen für Blankodrücke vorgenommen, etwa wird die maximale Anzahl an Elementwiederholungen erzeugt.
--
--; Formulartitel in der Kopfzeile anzeigen
--: Titel des Formulars im Kopfbereich des Dokumentes mitdrucken.
--
--; Seitenzahlen in der Fußzeile anzeigen
--: Seitanzahl in des Fußzeile des Dokumentes mitdrucken.
--
--; Datum in der Kopfzeile anzeigen
--: Aktuelle Daum im Kopfbereich des Dokumentes mitdrucken.
--
--; Zoomfaktor
++; **Dateiname**
++: Dateiname, unter dem das erzeugte PDF-Dokument gespeichert wird.
++; **Druckmodus Formular mit textueller Ausgabe von Werten**
++: Eingabefelder werden in Text umgewandelt und das Formular wird in der Breite entsprechend angepasst, siehe nächster Abschnitt.
++; **Druckmodus Formular mit Eingabefeldern**
++: Das Formular wird so in dem PDF ausgegeben wie es auch im Browser aussieht.
++; **Zoomfaktor**
  : 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.
--
--; Rand
--: Einstellungen für den Rand für oben, links, rechts und unten in Millimeter.
--
--; Status beim Drucken
--: In Abhängigkeit von einem bestimmten Status drucken. Durch die Einstellungsmöglichkeit [[Verfügbar wenn>>doc:Formcycle.Designer.Form.ElementProperties.AvailableOnlyIf||target="_blank"]], können Formularelemente abhängig vom Status ausgeblendet werden und somit kann das Druckbild beeinflusst werden.
--
--; Benutzergruppen
++; **Benutzergruppen**
  : 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.
--
--; URL-Parameter
++; **URL-Parameter**
  : 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.
--; Timeout (in Sekunden)
--: Timout, bis der Druck abgebrochen wird, weil z.b. der Dienst nicht erreichbar ist. Die Standardeinstellung von 30 Sekunden zu ändern, kann dann sinnvoll sein, wenn die Last für den Druckprozessor erhöht ist um alle Anfragen abzuarbeiten.
--
--; Zeitpunkt für die PDF-Erstellung selbst bestimmen
--: Falls in einem selbst geschriebenen Java-Script verzögert Abfragen ausgeführt werden, dann kann mittels dem Parameter //window.print.status = true//, der Druck angestoßen werden. Dazu muss aber die Checkbox aktiviert werden. Sonst erfolgt der Druck sobald aus Sicht des Printers das Formular fertig geladen ist und Skripte ausgeführt wurden. Hierbei handelt es sich um eine fortgeschrittene Einstellung und sollte nur verwendet werden, wenn dies wirklich gebraucht wird.
--
--; Dateiname
--: Dateiname, unter dem das erzeugte PDF-Dokument gespeichert wird.
--
--; An den Vorgang anhängen
--: Die Datei dauerhaft speichern. Diese Einstellung ist auch notwendig, wenn die Datei z.B. auf einer Abschlussseite als Download (mittels [[Attachment-Platzhalter>>doc:Formcycle.UserInterface.Variables||anchor="HSystemplatzhalterfFCrHTML-Templates" target="_blank"]]) angeboten werden soll.
--
  == CSS-Anpassungen für Druckbild ==
--Allgemeine CSS-Anpassungen für den Druck können über eine entsprechende Media-Query umgesetzt werden:
--
--{{code language="css"}}
--@media print {
--   /* general CSS for printing */
--}
--{{/code}}
--
--Hier ist zu beachten, dass dieses CSS auch angwandt wird, wenn das Formular etwa direkt über den Browser gedruck wird.
--
--Weiterhin gibt es speziell für den Print-Service noch folgende spezielle CSS-Klassen, welche immer an das //form.xm-form//-Element angefügt werden (erfordert mindestens Print-Plugin Version 4.2.0 und Print-Server-Plugin 1.4.0).
--
--; xm-print
--: Wird immer angefügt.
--; xm-print~-~-mode-plain
--: Wird angefügt, wenn als Druckmodus //Formularfelder bewahren// ausgewählt ist.
--; xm-print~-~-mode-dynamic
--: Wird angefügt, wenn als Druckmodus //Formularfelder in Text umwandeln// ausgewählt ist.
--; xm-print~-~-style-filled
--: Wird angefügt, wenn die Option //Blankodruck// deaktiviert ist.
--; xm-print~-~-style-blank
--: Wird angefügt, wenn die Option //Blankodruck// aktiviert ist.
--
  === Textfelder und Auswahllisten ===
--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 //Formularfelder in Text umwandeln// 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:
++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:
  {{code language="css"}}
  .print.XSpan {
@@ -372,128 +372,6 @@
  ==== Rechtliche Hinweise ====
--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.
++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.
  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.
--
--== JavaScript-Anpassungen für Druckbild ==
--
--Manchmal kann es erforderlich sein, vor dem Druck noch JavaScript auszuführen. Hierzu kann die Funktion //$.xutil.onPrint// verwendet werden, welche folgende Signatur hat
--
--{{code language="text"}}
--function onPrint(callback: () => Promise<void> | void): void
--{{/code}}
--
--Mit dieser Funktion können ein oder mehrere Callbacks registriert werden, welche vor dem Druck ausgeführt werden. Wenn ein Callback ein //Promise// zurückliefert, wird mit dem Druck gewartet, bis das Promise erfüllt ist. Falls das Promise abgewiesen wird, wird der Fehler gelogged, der Print aber nicht abgebrochen. Zu beachten ist weiterhin, dass die Registrierung der Callbacks vor dem Druck erfolgen muss, also beispielsweise innerhalb eines JQuery-Document-Ready-Handlers (//$(callback)//).
--
--Falls beispielsweise ein AJAX-Request fertig ausgeführt werden soll, bevor mit dem Druck begonnen wird:
--
--{{js}}
--  $.xutil.onPrint(async () => {
--    const response = await fetch("http://some-url.de");
--    // do something with response
--  });
--{{/js}}
--
--{{jsIE}}
--  $.xutil.onPrint(function() {
--    return new Promise(function(resolve, reject) {
--      $.ajax("http://some-url.de", {
--        success: function(data, textStatus, jqXHR) {
--          // Do something with the response data
--          resolve(undefined);
--        },
--        error: function(jqXHR, textStatus, errorThrown) {
--          reject("HTTP request error: " + textStatus + " - " + errorThrown);
--        },
--      });
--    });
--  });
--{{/jsIE}}
--
--== Versionshistorie ==
--
--=== Plugin ===
--
--==== 4.3.0 ====
--
--* Feature: Neue Option zum erneuten Versuchen des Drucks bei Fehlern.
--
--==== 4.2.3 ====
--
--* Fix: Sonderzeichen im Wert von Auswahloptionen bei Combobox-Felder werden nun immer korrekt im Druck dargestellt.
--
--==== 4.2.2 ====
--
--* Fix: Bei Textareas, wo die automatische Höhenanpassung aktiviert ist, wird vor dem Druck die Höhe noch einmal neu berechnet.
--
--==== 4.2.1 ====
--
--* Fix: Version des Print-Server beim Check wird korrekt angezeigt
--
--==== 4.2.0 ====
--
--* Feature: Neue Option //Blankodruck// im Plugin
--* Feature: Es werden einige CSS-Klassen //xm-print// an das  //form.xm-form// angefügt.
--* Change: Ist im Designer unter Print-Einstellungen (Word- und PDF-Export-Optionen) eingestellt, dass ein Element versteckt sein soll, wird dieses auch im Druck nicht mitgedruckt. FÜr dieses Features ist {{formcycle/}} Version 7.0.14 oder höher erforderlich.
--* Change: Betrifft den Druckmodus //dynamisch//: Hatte ein Eingabefeld keinen Wert, wurde stattdessen der Platzhalter (placeholder-Attribute) des Elements als Wert angezeigt. Dies ist verwirrend und wurde geändert. Hat ein Eingabefeld keinen Wert, wird auch kein Wert dargestellt.
--* Change: Betrifft den Druckmodus //dynamisch//: Hatte ein Auswahlfeld mit Darstellung Dropdown keinen Wert, wurde //Bitte auswählen// als Wert angezeigt. Dies wurde so geändert, dass nun kein Wert angezeigt wird.
--
--==== 4.1.2 ====
--
--* Hinweis in der Plugin-Oberfläche bezüglich //$.xutil.onPrint// ergänzt.
--
--==== 4.1.1 ====
--
--* Erfordert wenigstens {{formcycle/}} in Version 7.0.4.
--* Change: Pflichtfeldhinweis wird nicht mehr angezeigt
--* Fix: Datumformat wird wieder sofort eingeblendet
--
--==== 4.1.0 ====
--
--* Status zum Drucken kann ausgewählt werden. Ist kein Status ausgewählt, wird wie bisher der aktuelle Status des Vorgangs genommen.
--* Konfigurierte Nutzergruppen werden korrekt an der Aktion gespeichert.
--
--==== 4.0.2 ====
--
--* Es kann nun ein Timeout gesetzt werden. Ist der Print-Service nicht erreichbar, wird die Aktion sonst möglicherweise nie abgebrochen.
--
--==== 4.0.1 ====
--
--* Fix: In der Aktion für den neuen Workflow wurde die Datei nicht an den Vorgang angehangen.
--
--==== 4.0.0 ====
--
--* Anpassungen für {{formcycle/}} Version 7.
--
--=== Server ===
--
--==== 1.6.1 ====
--
--* Fix compatibility with Windows service installation script
--
--==== 1.6.0 ====
--
--* Es wird nun Chromium 108.0.5351.0 zum Drucken genutzt.
--* Neues CLI-Flag --disableCache=true zum Deaktivieren des Browser-Cache.
--* Neues CLI-Flag --isolatedBrowser=true um einen separaten Browser für jeden Print-Request zu verwenden.
--* Fix Debian Install-Script, installiere auch libgbm1.
--
--==== 1.5.1 ====
--
--* Abhängigkeit node-windows aktualisiert
--
--==== 1.5.0 ====
--
--* Update auf Chromium 105.0.5173.0
--* Erfordert mindestens Node.JS 14 oder höher
--
--==== 1.4.1 ====
--
--* Script zum Installieren / Deinstallieren des Windows-Services ist wieder lauffähig (//install-windows-service.js// und //uninstall-windows-service.js//)
--
--==== 1.4.0 ====
--
--* Bei Fehlern während des Druckens wird dieser Fehler mit der HTTP-Antwort zurückgeliefert
--* Print-Server kann nun zum Drucken beliebiger Webseiten genutzt werden. JavaScript und CSS, welche im Kontext der zu druckenden Seite ausgeführt werden soll, kann nun mit der HTTP-Anfrage übergeben werden.
--* Bei Aufruf des Pfads ///pdf// liefer der Print-Server nun eine Status-Report des Servers zurück.