Changes for page Print-Service-Plugin

From 9.1 to 10.1

From version 10.1

edited by awa
on 14.06.2022, 13:52

Change comment: Add changelog

To version 11.12

edited by awa
on 23.06.2023, 17:04

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -12,19 +12,17 @@
  To use the //Print-Service// plugin, it is necessary to install //Node.js// and the //Print Server//. This can be installed on the same server as the {{formcycle/}} master server.
--== Installation ==
++== Installation Print Server on Windows ==
  The installation of the required //Print Server// requires different procedures depending on the operating system.
--=== Installation Print Server on Windows ===
++=== Installation of Node.js ===
--==== Installation of Node.js ====
--
  : 1. Download the LTS version from https://nodejs.org/
  : 2. Run the MSI file
  : 3. Run the wizard steps, leaving default settings as they are
--==== Installation steps for the Print Server ====
++=== Installation steps for the Print Server ===
  : 4. Download the Print Server installation files from the Customer Cloud [[here>>https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/fc-plugin-print-service/Print%20Server&fileid=18856]].
  : 5. unzip the ZIP file "print_server_fc.zip" and move the content to the folder print_server_fc under {{code language="none"}}C:\Programs\{{/code}}.
@@ -46,7 +46,7 @@
  After the installation, a folder named {{code language="none"}}deamon{{/code}} is created for the log files.
--==== Uninstall ====
++=== Uninstall ===
  Für die Deinstallation des Print Servers, öffnen Sie eine Kommandozeile (cmd) mit administrativen Berechtigungen und führen Sie folgende Befehle aus.
@@ -55,10 +55,13 @@
  node uninstall-windows-service.js
  {{/code}}
++== Installing Print Server under Linux ==
--=== Installing Print Server under Linux ===
++{{info}}
++  Contrary to earlier versions, you need to copy ALL files from the ZIP file with the print server.
++{{/info}}
--==== Installation steps for installing Node.js and the Print Server ====
++=== Installation steps for installing Node.js and the Print Server ===
  To install, open the console and run the following commands:
@@ -105,15 +105,24 @@
  During the installation, depending on the existing system, some Linux packages such as nodejs were also installed. However, it is not possible to uninstall the packages automatically. Delete the automatically installed packages only if you are 100% sure that they are no longer needed!
  {{/info}}
--=== Test ===
++== Using IPv6 ==
--To check if the installation was successful, the service can be called on the server for a test:
--{{code language="none"}}http://localhost:8090/pdf?orientation=landscape&format=A4&wait=false&marginTop=0mm&formURL=http://www.formcycle.de{{/code}}
++Starting with version 2.0.1, the server binds to both IPv4 and IPv6 addresses by default, using the dual stack feature supported by most operating systems. Should that fail, the print server binds only to IPv4 addresses (0.0.0.0).
--=== Plugin setup ===
++If required, you can also set a different bind address via the command line parameter "--bindAddress".
--==== Print-Service Plugin Installation ====
++== Test ==
++To check if the installation was successful, the service can be called on the local server for a test (in that case it should be printed the formcycle.de website):
++
++{{code language="none"}}
++http://localhost:8090/pdf?orientation=landscape&format=A4&wait=false&marginTop=0mm&formURL=http://www.formcycle.de
++{{/code}}
++
++== Plugin setup ==
++
++=== Print-Service Plugin Installation ===
++
  In order for the plugin to be available in {{formcycle/}} as an action in the workflow, it must be deployed in the System Plugin section of the management interface. Instructions for installing plugins can be found [[here>>doc:Formcycle.UserInterface.Client.Plugins.WebHome]].
  If the old version of the print service plugin (phantom plugin) was already installed, the following procedure is recommended for installation:
@@ -123,7 +123,7 @@
  * Upload new print service plugin
  * Proceed with the configuration
--==== Plugin Configuration ====
++=== Plugin configuration ===
  After the plugin has been installed, the service URL must be adjusted. This is defined in the plugin via the mandatory parameter {{code language="none"}}pdf.print.services.url{{/code}}.
@@ -177,8 +177,8 @@
  The described steps are only a workaround and the environment variables should be set back to the default values after the successful installation!
  {{code language="none"}}
--PS C:\test> $env:NODE_TLS_REJECT_UNAUTHORIZED = 0
--PS C:\test> npm set strict-ssl false
++PS C:\test> $env:NODE_TLS_REJECT_UNAUTHORIZED = 0
++PS C:\test> npm set strict-ssl false
  {{/code}}
  == Usage and options ==
@@ -194,14 +194,37 @@
  ; Zoom factor
  : Scale factor for the form. Use this to magnify or scale down very large or very small forms.
  ; Blank form
--: Can be used to create PDF documents that can be printed out and filled out manually with a pen. When enabled, all form field values are cleared and all hidden fields are shown. In addition, the maximum number of element repetitions are created.
++: (requires at least print plugin version 4.2.0 and print service version 1.4.0) Can be used to create PDF documents that can be printed out and filled out manually with a pen. When enabled, all form field values are cleared and all hidden fields are shown. In addition, the maximum number of element repetitions are created.
  ; User groups
  : A virtual user is created when opening the form with Selenium. Select the user groups here to which this virtual user should belong to. Form elements can be configured to be displayed or editable only for certain user groups.
  ; URL parameter
  : Additional URL parameters added to the URL used when opening the form with Selenium. You can use URL parameters to [[prefill form fields>>Formcycle.Designer.Form.URLParameter]] or access them from within JavaScript.
--== CSS-Anpassungen für Druckbild ==
++== CSS adjustments ==
++General CSS adjustments can be done via a corresponding media query:
++
++{{code language="css"}}
++@media print {
++   /* general CSS for printing */
++}
++{{/code}}
++
++Please note this CSS is applied in other printing contexts as well, e.g. when the user prints the form via the browser directly.
++
++There are a few special CSS classes available that are set only when the print service is used. These classes are always added to the //form.xm-form// element.(requires at least print plugin version 4.2.0 and print server plugin 1.4.0).
++
++; xm-print
++: This CSS class is always set.
++; xm-print~-~-mode-plain
++: Added when print mode is set to //Preserve form fields//.
++; xm-print~-~-mode-dynamic
++: Added when print mode is set to //Convert form fields to text//.
++; xm-print~-~-style-filled
++: Added when the option //blank form// is disabled.
++; xm-print~-~-style-blank
++: Added when the option //blank form// is enabled.
++
  === Input elements ===
  To optimize the form for printing, form elements of type [[input field>>Formcycle.Designer.Form.FormElements.Input]], [[text area>>Formcycle.Designer.Form.FormElements.Textarea]] und [[select>>Formcycle.Designer.Form.FormElements.Selection]] (Drop-Down) may be converted to plain text fields, if the print mode is set to Input elements as text.
@@ -290,39 +290,140 @@
  In fonts of type //TrueType// and //OpenType// information about the embeddability of the font can be stored directly. Depending on what is configured there, a font may not be embeddable and will instead be rendered by the //Print-Service-Plugin// only as a vector graphic in the created PDF documents.
--== Changelog
++== JavaScript adjustments ==
--=== 4.2.0
++Sometimes you may have to execute custom JavaScript code before the form is printed. For this, you can use the function //$.xutil.onPrint//. Its signature is as follows:
++{{code language="text"}}
++function onPrint(callback: () => Promise<void> | void): void
++{{/code}}
++
++This function lets you register one or more callbacks that are run before the form is printed. When a callback returns a promise, the print server waits until the promise fulfills before proceeding with the printing. In case the promise gets rejected, the error is logged, but the print is not aborted. Please note that you must register the callback before the form is printed, e.g. within a JQuery document-ready-handler (//$(callback)//).
++
++For example, to run an AJAX request and wait for it to finish before the form is printed:
++
++{{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}}
++
++== Changelog ==
++
++=== Plugin ===
++
++==== 4.3.1 ====
++
++* fix: Always show the selected appointment date, if any, regardless of the print mode
++
++==== 4.3.0 ====
++
++* feature: New option to retry printing in case of a failure
++
++==== 4.2.3 ====
++
++* Fix: Special characters in combobox select options are now displayed correctly in the printed PDF document
++
++==== 4.2.2 ====
++
++* Fix: When a textarea is set to adjust its height automatically to its content, the height is now recalculated once before the form is printed.
++
++==== 4.2.1 ====
++
++* Fix: Show correct version of the print server when performing a check
++
++==== 4.2.0 ====
++
  * feature: New option //blank form//
++* feature: Add special CSS classes to the //form.xm-form// such as //xm-print//
  * change: When an element is marked as hidden during print in the form designer (advanced -> Word and PDF export options), the element is now hidden when the print service is used as well. This feature requires at least {{formcycle/}} version 7.0.14.
  * change: Applicable only when //print mode// is set to //dynamic//: When an input field did not have a value, its placeholders was shown instead. This was changed so that no value is shown when the input field does not have a value.
  * change: Applicable only when //print mode// is set to //dynamic//:  When a select field displayed as a dropdown menu did not have a value, the text //Please select// was shown instead. This was changed so that no text is shown anymore when the select field does not have a value.
--=== 4.1.2
++==== 4.1.2 ====
  * Added note regarding //$.xutil.onPrint// to the plugin UI.
--=== 4.1.1
++==== 4.1.1 ====
  * Requires at least {{formcycle/}} 7.0.4.
  * change: Note regarding required field is not shown anymore.
  * fix: Show the date format immediately
--=== 4.1.0
++==== 4.1.0 ====
  * Added a new option for selecting the workflow state used during printing. When no state is selected, the current state of the form record is used as in previous version.
  * Configured user groups are saved correctly.
--=== 4.0.2
++==== 4.0.2 ====
  * feature: Added a new timeout option that defaults to 30 seconds. When the print service cannot be reached, the workflow may never complete otherwise.
--=== 4.0.1
++==== 4.0.1 ====
--* fix: The PDF document tha was created was not attached to the form record (only for the new workflow action).
++* fix: The PDF document that was created was not attached to the form record (only for the new workflow action).
--=== 4.0.0
++==== 4.0.0 ====
  * Adjustments for {{formcycle/}} version 7.
++=== Server ===
++
++==== 1.7.2 ====
++
++* Close alert messages when any are opened by JavaScript. Otherwise the print can never finish successfully.
++
++==== 1.7.1 ====
++
++* Update install scripts for Linux
++
++==== 1.7.0 ====
++
++* Switch to media type print before printing and wait until no network traffic is ongoing anymore before printing. This helps to show e.g. background graphics from @media print rules.
++
++==== 1.6.1 ====
++
++* Fix compatibility with Windows service installation script
++
++==== 1.6.0 ====
++
++* Update puppeteer to latest version, which uses Chromium 108.0.5351.0
++* Add CLI flag  //~-~-disableCache=true// to disable the browser cache--
++* Add CLI flag //~-~-isolatedBrowser=true// to use a new browser instance for each request.--
++* Fix Debian install script, install libgbm1.
++
++==== 1.5.1 ====
++
++* Update node-windows dependency
++
++==== 1.5.0 ====
++
++* Update to Chromium 105.0.5173.0
++* Requires at least Node.JS version 14 or higher
++
++==== 1.4.1 ====
++
++* Fix windows service install / uninstall script (//install-windows-service.js// and //uninstall-windows-service.js//)
++
++==== 1.4.0 ====
++
++* When an error occurs while printing, that error is returned as part of the HTTP response
++* The print server can now be used for printing arbitrary pages / URLs. JavaScript and CSS that must be run in the context of the page to print can be passed as part of the HTTP request.
++* The ///pdf// endpoint without parameters returns a quick summary of the server status