Changes for page Print-Service-Plugin

From 10.1 to 9.1

From version 9.1

edited by awa
on 13.06.2022, 18:29

Change comment: There is no comment for this version

To version 1.1

edited by gru
on 20.01.2021, 16:20

Change comment: Imported from XAR

Raw
Rendered

Summary

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

Details

Page properties

Author

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

Content

@@ -1,211 +1,48 @@
--[[**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"]] (requires login)
++[[**Plugin download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/plugin-bundle-phantomjs&fileid=342||target="_blank"]] (requires login)
  {{info}}
--{{formcycle/}} Version 7 requires the //Print-Service// plugin version to be **4.0.0** or higher.
++Please use **plugin version 2.0.0** or above for {{formcycle/}} Version 6.
  {{/info}}
  {{content/}}
--The plugin //Print Services// is available separately and lets you create a PDF document from a form that is optimized for printing. This plugin is subject to additional charge.
++The plugin //Print Services// is available separately and lets you create a PDF document from a form that is optimized for printing.
  == Technical details ==
--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.
++In technical terms, the conversion is done using Selenium and the driver //phantomJS//. The page format of the created PDF document is A4.
++{{warning}}
++When you print a form with the print services, JavaScript defined for the form is executed. However, please note that no newer JavaScript features are supported. Specifically, no features from {{smallcaps}}Ecma{{/smallcaps}}Script6 and higher are available. This that, for example, you cannot use new keywords such as //let// and //const// or new syntax such as arrow functions or destructuring.
++{{/warning}}
++
  == Installation ==
--The installation of the required //Print Server// requires different procedures depending on the operating system.
++The plugin can be installed as client plugin or system plugin. Instructions for installing plugins can be found [[here>>doc:Formcycle.UserInterface.Client.Plugins.WebHome]].
--=== Installation Print Server on Windows ===
++{{info}}There are several versions of the Print PDF plugin for different operating systems (//32-bit Linux//, //64-bit Linux//, //Windows//, //MacOSX//). It is only necessary to install the version of the plugin that corresponds to the operating system on which {{formcycle /}} is installed. The operating system used is displayed on the [[Server information>>Formcycle.SystemSettings.UserInterface.ServerInformation]] page.{{/info}}
--==== 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 ====
--
--: 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}}.
--
--To install, open the command line (cmd) with administrative privileges and execute the following commands:
--
--{{code language="none"}}
--cd C:\Programs\print_server_fc
--npm install
--npm install -g node-windows
--npm link node-windows
--node install-windows-service.js
--{{/code}}
--
--There now exists a new service {{code language="none"}}FORMCYCLE Print Server{{/code}}. Please check if this is also started before you run a [[test>>||anchor="HTest"]]. The script {{code language="none"}}install-windows-service.js{{/code}} contains default variables for installing the print service.
--
--* The service is installed on port 8090 by default. To change this, you need to adjust the {{code language="none"}}--port=8090{{/code}} parameter in the {{code language="none"}}install-windows-service.js{{/code}} file.
--* Logging is enabled by default. To change this set the parameter {{code language="none"}}--verbose=true{{/code}} to {{code language="none"}}--verbose=false{{/code}}.
--
--After the installation, a folder named {{code language="none"}}deamon{{/code}} is created for the log files.
--
--==== Uninstall ====
--
--Für die Deinstallation des Print Servers, öffnen Sie eine Kommandozeile (cmd) mit administrativen Berechtigungen und führen Sie folgende Befehle aus.
--
--{{code language="none"}}
--cd C:\Programs\print_server_fc
--node uninstall-windows-service.js
--{{/code}}
--
--
--=== Installing Print Server under Linux ===
--
--==== Installation steps for installing Node.js and the Print Server ====
--
--To install, open the console and run the following commands:
--
--{{code language="none"}}
--# Loading the script (varies depending on the operating system)
--
--#   Debian 10 - If you are logged in as root:
--wget "https://customer.formcycle.eu/index.php/s/0GBtp1HtQHJMzQx/download?path=/&files=install_printserver_debian10.sh" -O install_print_server.sh
--
--#   Debian 10 - or if you are logged in as a normal user with sudo rights:
--wget "https://customer.formcycle.eu/index.php/s/0GBtp1HtQHJMzQx/download?path=/&files=install_printserver_debian10_sudo.sh" -O install_print_server.sh
--
--#   Ubuntu 16 - If you are logged in as root:
--wget "https://customer.formcycle.eu/index.php/s/0GBtp1HtQHJMzQx/download?path=/&files=install_printserver_ubuntu16.sh" -O install_print_server.sh
--
--
--# Make file executable
--chmod 750 install_print_server.sh
--
--
--# Start installation
--./install_print_server.sh
--
--
--# Run Print Server
--systemctl start printserver
--{{/code}}
--
--In the first lines of the script - via the variables {{code language="none"}}PRINTSERVER_USER{{/code}} and {{code language="none"}}PRINTSERVER_USER_PWD{{/code}} - the user name/password to be created can be adjusted.
--The verbose parameter can be used to enable/disable the log output. The scripts for the service should be located at {{code language="none"}}/home/formcycle/print_server{{/code}}. In the start script the verbose parameter can be adjusted.
--
--Translated with www.DeepL.com/Translator (free version)
--
--=== Uninstall ===
--
--To uninstall the Print Server, open a command line (cmd) with administrative privileges and execute the following commands:
--
--{{code language="none"}}
--/home/formcycle/deinstall_printserver.sh
--{{/code}}
--
--{{info}}
--**Caution:**
--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 ===
--
--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}}
--
--=== 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:
--
--* Disable the phantom plugin
--* Delete the phantom plugin
--* Upload new print service plugin
--* Proceed with the 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}}.
--
--If the installation was done on the same server as {{formcycle/}}, then specify {{code language="none"}}localhost{{/code}} as the domain. If no changes have been made to the port, the setting {{code language="none"}}8090{{/code}} is retained.
--
--For example: {{code language="none"}}http://localhost:8089/pdf{{/code}}
--
--This completes the setup of the print service plugin and it is available as an action in the [[workflow processing>>doc:Formcycle.Designer.Workflow.WebHome]].
--
--== Troubleshooting ==
--
--=== Command npm not found ===
--
--Under Windows it is possible that after the NodeJS installation the environment variables are not set correctly and so npm install cannot be executed. This was also the case if the default path under C:/Programs was not used during the NodeJS installation. So check in the path if these are existing. The following must be done for this:
--
--* Call up the environment variables via Control Panel > System > Advanced System Settings > Environment Variables button.
--* In Path you should find the following entries: {{info}}C:\Users\{username}\AppData\Roaming\npm;C:\Program Files\nodejs{{/info}}
--* Confirm everything with Ok. The console then be opened again with admin rights.
--
--=== Command npm install leads to timeout ===
--
--If the npm install command does not work due to a proxy, then the general proxy setting is not sufficient. Therefore, the following must be executed via console:
--
--{{code language="none"}}
--npm config set proxy http://proxy.domain:port
--npm config set https-proxy https://proxy.domain:port
--{{/code}}
--
--If user data is required:
--
--{{code language="none"}}
--npm config set proxy http://user:pass@proxy.domain:port
--npm config set https-proxy https://user:pass@proxy.domain:port
--{{/code}}
--
--More information can also be found here: http://www.fladi.de/2014/02/06/howto-npm-hinter-einem-proxy-verwenden/
--
--=== Printing does not work ===
--
--If printing via {{formcycle/}} is not possible, the cause could be that the print service is not reachable. This can be solved by the loopback URL. Under System > General > Loopback URL, loopback base URL: {{code language="none"}}http://localhost:<port>/formcycle{{/code}}
--
--=== PDF is printed, but the message 404 appears ===
--
--In this case the print service works correctly because a PDF is already created. It must be checked whether the loopback URL is entered correctly so that the URL to the print service is resolved correctly.
--
--=== Downloading Chromium fails ===
--
--The following error message appears on the console after running "npm install":
--{{code language="none"}}Error: unable to verify the first certificate{{/code}}
--
--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
--{{/code}}
--
  == Usage and options ==
  To use this plugin, go to the workflow processing configuration, click on new action and select this plugin. The following options are used to configure the plugin action:
--; File name
++; **File name**
  : File name of the created PDF document.
--; Print mode
++; **Print mode**
  : Input elements as text: Input elements are converted into plain text fields and the form is adapted to the width of the page.
--; Print mode
--: By default, are form fields such as input fields and select fields are converted to plain text. If you choose to disable this conversion, no changes are made to the form and it is printed so that it looks as closely as it does in a web browser as possible.
--; 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.
--; User groups
++; **Print mode**
++: Web view: No changes are made to the form and it is converted so that it looks as closely as it does in a web browser as possible.
++; **Zoom factor**
++: Factory by which the form is scaled. Use this to magnify or scale down very large or very small forms.
++; **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.
++; **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.FormDesigner.URLParameter]] or access them from within JavaScript.
--== CSS-Anpassungen für Druckbild ==
++== Input elements ==
--=== Input elements ===
++To optimize the form for printing, form elements of type [[input field>>Formcycle.FormDesigner.FormElements.Input]], [[text area>>Formcycle.FormDesigner.FormElements.Textarea]] und [[select>>Formcycle.FormDesigner.FormElements.Selection]] (Drop-Down) may be converted to plain text fields, if the print mode is set to Input elements as text.
--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.
--
  Additionally, the CSS classes //print// and //XSpan// are added to the converted input element that can be used for styling them. For example, in order to change the font size, you can use the following CSS:
  {{code language="css"}}
@@ -218,7 +218,7 @@
  To overwrite some properties of the default CSS shipped with {{formcycle/}}, use more specific selectors such as:
  {{code language="css"}}
--.xm-form .xm-content div.print.XSpan {
++xm-form .xm-content div.print.XSpan {
    font-size: 18pt;
    font-family: serif;
  }
@@ -225,67 +225,3 @@
  {{/code}}
  Most properties do not require this, however.
--
--=== Enforce page break ===
--
--To create a defined page break, the page-break attributes must be set via CSS. The corresponding container or element has to be selected via the xn attribute. Please note that the CSS property //display //must be set to //block//, otherwise no line break will be created. In this example, a line break should be created before the container //div1//.
--
--{{code language="css"}}
--[xn=div2] {
--  display: block !important;
--  page-break-before: always;
--}
--{{/code}}
--
--=== Avoid page break ===
--
--The default setting for printing is that a page break is inserted after each page of the form:
--
--{{code language="css"}}
--@media print {
--    .CXPage:not(:first-child ), .page-break {
--        display: block !important;
--        page-break-before: always;
--    }
--}
--{{/code}}
--
--In order to avoid breaks, the following rule needs to be defined in the CSS tab of the form:
--
--{{code language="css"}}
--@media print {
--    .CXPage:not(:first-child ) {
--        page-break-before: avoid;
--    }
--}
--{{/code}}
--
--=== Usage of other fonts ===
--
--==== Technical requirements ====
--
--In order for fonts to be used and embedded in the created PDF documents, it is generally necessary for them to be installed on the server running the Print-Server.
--
--==== Inclusion via CSS ====
--
--To include a font installed on the server for printing, it must be explicitly defined with a {{code language="none"}}@media print{{/code}} query and set for use by the appropriate form elements. In the simplest case, this can look like the following example:
--
--{{code language="css"}}
--@media print {
--    @font-face {
--        font-family: 'DejaVu Sans';
--        src: local('DejaVu Sans');
--    }
--    .xm-form.modern *, .modern .XPage * {
--        font-family: "DejaVu Sans";
--    }
--}
--{{/code}}
--
--Here it is especially important that the identifier entered at {{code language="none"}}local(){{/code}} corresponds to the name of the font.
--
--==== Legal notice ====
--
--Fonts sometimes have very tightly defined license terms and are priced differently depending on their intended use. It should be noted that fonts for creating PDFs must be embedded in them, which for many commercial fonts requires a different license than for delivery via a web server for the purpose of displaying a web page in a web browser.
--
--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.