-
-
-
User Guide Version 2020.1 Last Revision: 2020-11-19 Objectif Lune, Inc. 2030 Pie-IX, Suite 500 Montréal, QC, Canada, H1V 2C8 +1 (514) 875-5863 www.objectiflune.com All trademarks displayed are the property of their respective owners. © Objectif Lune, Inc. 1994-2020. All rights reserved. No part of this documentation may be reproduced, transmitted or distributed outside of Objectif Lune Inc. by any means whatsoever without the express written permission of Objectif Lune Inc. Objectif Lune Inc.
-
Table of Contents Table of Contents 4 Welcome to PlanetPress Connect 2020.
-
The Connect server The Connect database The File Store The engines The REST API Log files Location Name Format Connect file types OL Connect projects 127 128 128 129 129 130 130 131 131 132 134 Project Wizards Project wizard: Basic Email Project Wizard: COTG Timesheets Project Wizard: Print Promotional Jobs Project Wizard: Print Transactional Jobs Project Wizard: Submitting Data with Web Forms Project Wizard: Serving a Web Page Workflow processes in OL Connect projects About Workflow processes Common OL C
-
Using the wizard for XML files Advanced PCL to PDF options Data mapping workflow Creating a data mapping workflow Testing the extraction workflow Data source settings Properties and runtime parameters Extracting data Steps The Data Model About records Creating a Data Model Editing the Data Model Using the Data Model Fields Detail tables Data types Data Model file structure DataMapper User Interface Keyboard shortcuts Menus Panes Toolbar Welcome Screen DataMapper Scripts API Using scripts in the DataMapper S
-
Print context Print sections Pages Master Pages Media Email Designing an Email template Creating an Email template with a Wizard Email context Email templates Email header settings Email attachments Web Creating a Web template with a Wizard Web Context Web pages Forms Using Form elements Using JavaScript Capture OnTheGo COTG Forms Creating a COTG Form Filling a COTG template Sending the template to the Workflow tool Using COTG data in a template Designing a COTG Template Capture OnTheGo template wizards Usi
-
Element types Editing HTML Attributes Inserting an element Selecting an element Deleting an element Styling and formatting an element Barcode Boxes Business graphics COTG Elements Date Forms Form Elements Hyperlink and mailto link Images Table Text and special characters Snippets Adding a snippet to the Resources Adding a snippet to a section Creating a snippet Editing a snippet Renaming a snippet Translating a snippet Styling and formatting Local formatting versus style sheets Layout properties Styling tem
-
Fonts Locale Spacing Personalizing content Variable data Conditional content Dynamic images and Print section backgrounds Dynamic tables Snippets Scripts Loading data Variable Data Formatting variable data Showing content conditionally Conditional Print sections Dynamic images Dynamic Table Dynamic Print section backgrounds Personalized URL Preferences General preferences COTG Servers preferences Clean-up Service preferences DataMapper preferences Database Connection preferences Editing preferences Email pr
-
Web preferences Writing your own scripts Script types Creating a new Standard Script Writing a script Setting the scope of a script Managing scripts Testing scripts Optimizing scripts The script flow: when scripts run Selectors in Connect Loading a snippet via a script Loading content using a server's API Using scripts in Dynamic Tables Control Scripts Post Pagination Scripts Translating templates Translating a template Tagging elements for translation Pluralization Exporting and importing translation files
-
Fax output Email output Web output Generating Print output Generating Print output from the Designer Generating Print output from Workflow Print settings in a template Aborting content creation Print using standard print output settings Print Presets Print using Advanced Printer Wizard Adding print output Models to the Print Wizard Splitting printing into more than one file Print output variables Generating Fax output Generating Tags for Image output Generating Email output Before generating Email output Te
-
Connect 2020.1 Designer Improvements Connect 2020.1 DataMapping Improvements Connect 2020.1 Output Improvements Workflow 2020.1 Improvements OL Connect Send Improvements Known Issues Previous Releases License Update Required for Upgrade to Connect 2019.x Backup before Upgrading Overview OL Connect 2019.2 Enhancements Connect 2019.2 Designer Improvements Connect 2019.2 DataMapping Improvements Connect 2019.2 Output Improvements Workflow 2019.
-
Connect 2018.1.5 Enhancements/Fixes Connect 2018.1.4 Enhancements/Fixes Connect 2018.1.3 Enhancements/Fixes Connect 2018.1.2 Enhancements/Fixes Connect 2018.1.1 Enhancements/Fixes Connect 2018.1 General Enhancements Connect 2018.1 Designer Enhancements/Fixes Connect 2018.1 DataMapping Enhancements/Fixes Connect 2018.1 Output Enhancements/Fixes Workflow 2018.1 Enhancements/Fixes Known Issues Overview Connect 1.8 General Enhancements and Fixes Connect 1.8 Performance Related Enhancements and Fixes Connect 1.
-
Connect 1.5 DataMapping Enhancements and Fixes Connect 1.5 Output Enhancements and Fixes Connect 1.5 General Enhancements and Fixes Connect 8.5 Workflow Enhancements and Fixes Known Issues Overview Connect 1.4.2 Enhancements and Fixes Connect 1.4.1 New Features and Enhancements Connect 1.4.1 Designer Enhancements and Fixes Connect 1.4.1 DataMapping Enhancements and Fixes Connect 1.4.1 Output Enhancements and Fixes Connect 8.4.
-
Welcome to PlanetPress Connect 2020.1 Note Since we are always looking for new ways to make your life easier, we welcome your questions and comments about our products and documentation. Use the feedback tool at the bottom of the page or shoot us an email at doc@ca.objectiflune.com. PlanetPress Connect is a series of tools designed to optimize and automate customer communications management. They work together to improve the creation, distribution, interaction and maintenance of your communications.
-
Setup And Configuration This chapter describes the PlanetPress Connect installation and the different considerations that are important in regards to the installation and use of PlanetPress Connect. l "System and Hardware Considerations" below l "Installation and Activation" on page 34 l "Known Issues" on page 110 l "Server Configuration Settings" on page 89 l Uninstalling System and Hardware Considerations There are a variety of considerations to be aware of.
-
Directories and folders All Connect applications are installed under an arbitrarily selectable main folder. If the default installation folder options were used, this installation folder would be %PROGRAMFILES%\Objectif Lune\OL Connect. The installation folder will hold all the executable files and other files and folders required for the operation of the whole product suite. All these files and folders remain static after installation.
-
Working folders Working folders for Connect are created and used on a per-user-basis under the respective user's profile folder, accessible on Windows with the standardized system variable %USERPROFILE% in the subfolder "Connect". Working folders are: l l l l %USERPROFILE%\Connect\filestore: This folder will hold non-intermediate files for the operation of Connect. Files in this folder will be used frequently, but not with a high frequency.
-
Database Considerations This page describes the different considerations and pre-requisites for the database back-end used by PlanetPress Connect, whether using the MySQL instance provided by the installer, or pre-existing (external) instance. Using the MySQL Instance from the Installer The MySQL Instance provided in the Installation Wizard is already pre-configured with options to provide the most stable back-end setup. These are the specific options that have been changed in our version of "my.
-
Warning If you chose not to install the supplied MySQL database, and instead opt for using a preexisting (External) database then you yourself must ensure that the External database is accessible to Connect. Objectif Lune Inc. will take no responsibility for database connections to any but the supplied MySQL database. Options available within the installer: l l l The Configuration page for the local MySQL is displayed.
-
Server is SQL Server 2012. l l l When MS SQL is selected, the default values for root user are sa and 1433 for the port. If database settings from a previous OL Connect installation are found, the pre-exising settings will be displayed for the matching database type. For MS SQL settings, this will only work if they were created with Server Config Tool 1.5.0 or later, or the Installer for OL Connect 1.6.0 or later.
-
supplied MySQL service. Note The Microsoft SQL selection capability will be available only with 1.6 version and upwards. To remove this dependency the user needs to do the following 1. Have a foreign Microsoft SQL running, ready for use with Connect Server. 2. Use the Server Configuration Tool "Database Connection preferences" on page 822 to switch the database to Microsoft SQL. 3. Re-start the Connect Server Service, so that the modifications become active. 4.
-
l It is not possible to uninstall the supplied MySQL hereafter, when running the Connect 1.5 Installer in Modify mode. Important If a Server Product and a MySQL Product were selected to be installed on Connect 1.5.0, and then the Server Configuration Tool is used to switch the database used by the Server to an external Microsoft SQL, then the Update to 1.6 requires an extra step. The procedure is as follows: 1. Run the Update to Connect 1.6.
-
will not be supported by Objectif Lune Inc.. Furthermore, using PlanetPress Connect in a Terminal Service environment is an infringement of our End-User License Agreement. Virtual Machine Support PlanetPress Connect supports the following virtual environments: l l l VMWare Environments. This includes VMWare Player, VMWare Workstation as well as VMWare ESX Server. VMWare VMotion.
-
PlanetPress Connect 1.3 and later have been certified under Remote Desktop. 32-bit or 64-bit Operating Systems? PlanetPress Connect is a 64-bit software and can only be installed on 64-bit operating systems. Antivirus Considerations l l Antivirus software may slow down processing or cause issues if they are scanning in temporary folders or those used by PlanetPress Connect. Please see "Antivirus Exclusions" on page 16 for more information.
-
entries and command-line switches are accepted, when one of Connect components is started and run. Please be therefore advised, that any non-whitelisted ini entry or command-line switch will be accepted and will - if tried to be used - lead to the respective application’s “sudden death”. If you should encounter such a behaviour then please double-check your Connect log file/s for respective entries.
-
l If a local proxy is configured (in the Internet Explorer Options dialog), the option Bypass proxy server for local addresses must be checked, or some features depending on local communication will not work. Firewall/Port considerations The following describes all of the ports that can be used by an OL Connect solution. IT staff may decide the firewall strategy to follow for their internal requirements and needs depending on the statements outlined herein.
-
Listens on port Destination # port # plugin Secure Email Output plugin LPR LPD 515 Telnet 9100 FTP Input/Output MySQL 3306 Microsoft 1433 SQL Server HyperSQL 9001 Type 587 TCP 515 TCP TCP TCP 21 TCP Comment TCP+UDP TCP+UDP TCP l Port numbers in bold type are user configurable. l Port numbers in bold underlined type are based on the type of database used. l Some of the ports listed above may also be used by other modules.
-
Performance analysis details Connect's output speed is limited to a certain number of output items (web pages, emails, or printed pages) per minute. What the maximum total output speed will be is determined by your licence and any additional Performance Packs you might have (see "Speed quota: Pages Per Minute" on page 93).
-
Configuring these engines to match both the hardware configuration and the typical usage situation is probably the most effective way to improve Connect's performance. The number of engines is one of the "Parallel Processing Preferences" that let the Connect Server manage its workload in such a way that the highest possible output speed is achieved. For an explanation and guidelines to these settings, see "Engine configuration" on page 91 and "Parallel Processing preferences" on page 101.
-
Connect stores intermediate files. You could exclude the entire C:\Users\\Connect folder. See also: "Antivirus Exclusions" on page 16. l l l l l Use a high-performance, low-latency hard drive. Connect benefits from fast I/O. This is especially true for DataMapper engines (see "DataMapper engine" on page 95). Preferably use a Solid State Drive (SSD) or similar for storage. Use at least 8+ GB High-Quality RAM.
-
Note Windows Vista, Windows 8.0, Windows 2003 Server and earlier versions of Windows are not supported by OL Connect products. Virtual Environments l VMWare/VSphere l Hyper-V l Azure l Amazon Web Services (AWS). Note that only EC2 M4 was certified, other instances may not work as expected. Minimum hardware requirements As with any software application, minimum hardware requirements represent the most basic hardware on which the software will run.
-
l File system: NTFS (FAT32 is not supported) l CPU: Intel Core i7-4770 Haswell or equivalent l RAM: 16GB l Disk Space: 4GB for the software modules, 20GB for work files* l Storage Type: Solid State Drive (SSD) l Networking: 10Gb Ethernet * This depends on the amount of data you process through OL Connect. For instance, a PostScript file containing several thousands of documents could easily take up several GBs.
-
Note As with any JAVA application, the more RAM available, the faster PlanetPress Connect will execute. Installation and Activation This topic provides detailed information about the installation and activation of PlanetPress Connect 2020.1. Note A PDF version of this guide is available for use in offline installations. Click here to download it. PlanetPress Connect 2020.1 is comprised of 2 different installers: one for the PlanetPress Connect software and one for PlanetPress Workflow 2020.1.
-
l "Installation prerequisites" below l "User accounts and security" on the facing page l "Migrating to a new workstation" on page 58 l "Upgrading from previous Connect versions" on page 67 Installation - "How to" guides For information on how to conduct the installation itself, choose from the following topics: l "Installation Wizard" on page 38 l "Running Connect installer in Silent Mode" on page 47 l "Installing PlanetPress Connect on Machines without Internet Access" on page 37 Activation F
-
.NET 3.5 must also be installed. This will need to be installed manually, as .NET 3.5 is not included in the Workflow setup. User accounts and security Connect requires local Windows Administrator rights when installing the software and activating the software license. This is to allow read/write access to protected Windows folders and registry entries. Once installed Connect requires only standard Windows user credentials to run.
-
l In the Connection tab, define the account name and password that the service should use. This can be a local account on the computer or an account on a Windows Domain. The account must have administrative access on the machine. It should also correspond to the user account set up in PlanetPress Worfklow. Installing PlanetPress Connect on Machines without Internet Access Installing PlanetPress Connect2020.1 in offline mode requires some extra steps. These are listed below.
-
2. Install the certificates: Right mouse click -> Install Certificate, and follow the steps through the subsequent wizard. 3. Now copy the PlanetPress Connect installer to the offline machine and start the installation as normal Windows certificate validation - Certificate Revocation List retrieval should be switched off For your security Objectif Lune digitally signs all relevant files with our own name and certificate.
-
page 67 Starting the PlanetPress Connect installer The PlanetPress Connect installer may be supplied as an ISO image or on a DVD. l If an ISO image, you can choose between the following, depending upon your Operating System and the choices available: 1. Burn the ISO image onto a DVD 2. Un-zip the contents to a folder (keeping the internal folder structure intact) 3.
-
l l l PlanetPress Connect Designer: The Designer module (see "The Designer" on page 421) can be installed standalone (with no other installed modules) on as many machines as you like. It does not require a license to run as a standalone designer tool . This allows for any number of people to use the Designer for creating jobs, but without production capabilities such as automation and commingling.
-
characters that Windows disallows in filenames (such as '?', ''>' or trailing spaces). If an invalid character is entered, the Installation Path entry box will turn red and a description of the error will be displayed in the information area. The installer can also calculate how much disk space is required for installing the selected components as well as how much space is available: l l l l Disk space required: Displays the amount of space required on the disk by the selected components.
-
l a lower case character (a, b, c ... ) l an upper case character (A, B, C ...) l a numeric digit (1, 2, 3 ...) l a punctuation character (@, $, ~ ...) For example: "This1s@K" Note When updating from an earlier Connect version, the appropriate MySQL password must be entered or the update will fail. If the password is subsequently forgotten, then MySQL must be uninstalled and its database deleted from disk before attempting to reinstall.
-
machine. It will also be required if the MySQL database is on a separate machine to this PlanetPress Connect installation. Tip This option may represent a security risk if the machine is open to the internet. We heavily recommended that your firewall is set to block access to port 3306 from external requests. Configuring External Database Connection The Database Connection page appears if the supplied MySQL module was not selected for installation.
-
created/modified/dropped in the database. If accessing a database on a different machine, the server must also be able to accept non-local TCP connections, and the user account must also be configured to accept remote connection. For example, the "root" MySQL user entered as root@localhost is not allowed to connect from any other machine than the one where MySQL is installed. l l Administrator Password: Enter the password for the above user account.
-
PlanetPress Connect Server Configuration The Server Configuration page is where the Connect Server component is configured. Connect Server settings The Connect Server settings are as follows:. l Run Server as: Defines the machine username and password that the Connect Server module's service uses. Note The user account must have access rights to all local and network resources required for production, as well as Windows "Log on as a Service" rights.
-
Selection Confirmation This page confirms the installation selections made. Click Next to start the installation itself. This process can take several minutes. Completing the installation This screen describes a summary of the components that have been installed. l l l Configure Update Check checkbox: This option is enabled by default. It causes the Product Update Manager to run after the installation is complete. This allows configuring PlanetPress Connect to regularly check for entitled updates.
-
l l Note that the Product Update Manager can also be called from the “Objectif Lune Update Client” option in the Start menu. It can be uninstalled via Control Panel | Programs | Programs and Features. Product Activation After installation, it is necessary to activate the software. See Activating your license for more information. Before activating the software, please wait 5 minutes for the database to initialize.
-
l Comment Lines, starting with # (e.g. # The options to configure an external database) l Key = Value pairs (e.g. install.product.0 = Connect Designer) For supported keys, please refer to the next paragraph. Note The install.properties file notation must follow commons configuration rules. Please refer to Properties files for more details. Required and optional properties Required properties depend on the specified product. Only fields related to that specified product must be entered.
-
Verbose logging (optional) By default, the Silent Installer will log the same way as the GUI installer. That means logging of error and warnings, and certain information during database configuration. A more verbose logging can be switched on by using logging.verbose = true. Product selection (optional) By default, if nothing is entered for the products to be installed (install.product.
-
Database configuration Case 1: MySQL is among the selected Connect products to be installed (new MySQL installation) If MySQL is selected and there is no previous MySQL configuration on the machine, the following properties should be defined: database.password = (required and must meet the rules) database.port = (3306 is the default port value) database.
-
Case 2: The Connect Server is selected and MySQL is not selected In this case, an external database must be configured for the Server (and other Connect products included in the Silent installation) to be used. 2a: Configuring an external MySQL database To configure an external MySQL database, the following properties should be defined: database.type = mysql (required) database.host = (default value is localhost, otherwise required) database.
-
Repository selection The Connect installation process requires a repository from which the installer copies (locally) or downloads (online installation) all selected Connect products. In Silent Installer mode, the installation process looks for the property product.repository in the install.properties file and then proceeds with the following steps: 1. If the property exists, and its value contains an existing file location with a repository, the installer will attempt to install from that repository. 2.
-
l en-US (English, US) l de-DE (German, Germany) l fr-FR (French, France) l ja-JP (Japanese, Japan) l zh-CN (Chinese, China) l zh-HK (Chinese, Hongkong) l zh-MO (Chinese, Macau) l zh-TW (Chinese, Taiwan) l it-IT (Italian, Italy) l pt-BR (Portuguese, Brazil) l es-419 (Spanish, Latin America) Locale selection by defining user.language and user.country If both user.language and user.country are defined in the install.
-
1. If the System Locale is in the list of supported Locales, it will be selected. 2. Otherwise, if there is an entry in the list of supported Locales, which matches the System language, it will be selected (e.g. on a fr-CA system, fr-FR is selected). 3. As last resort, the first Locale in the preinstall.ini is selected (usually that should be enUS). Getting the exit code of a silent installation If getting the exit code of a silent installation is desirable, use the following procedure. 1.
-
if errorlevel 10 goto err_installer if errorlevel 2 goto err_unknown if errorlevel 1 goto err_preinstall echo Success goto:eof :err_installer echo "Installer error - see OL_Install_.log" goto:eof :err_unknown echo "Unknown preinstall error - see preinstall_err.log" goto:eof :err_preinstall echo "Preinstall error - see preinstall_err.
-
l The PlanetPress Connect Software Activation application consists of the following: l License Information subsection: l l l Magic Number: Displays the PlanetPress Connect Magic Number. Copy the magic number to the clipboard: Click to copy the Magic Number to the clipboard. It can then be pasted in the activation request email using the Windows CTRL+V keyboard shortcut. Licensed Products subsection: l Name: Displays the name of the application or module relevant to this activation.
-
l l Customers must submit their Magic Number and serial number to Objectif Lune via the Web Activations page: http://www.objectiflune.com/activations. The OL Customer Care team will then send the PlanetPress Connect license file via email. Resellers can create an evaluation license via the Objectif Lune Partner Portal by following the instructions there: http://extranet.objectiflune.com/ Note that if you do not have a serial number, one will be issued to you by the OL Activations team.
-
l l l Click the Load License File button, and browse for the .olconnectlicense file you received from Objectif Lune Inc.. Read the EULA and click the I agree option to accept it. Click Install License to activate the license. The license will then be registered on the computer and you will be able to start using the software. Warning After installation message will appear warning that the Server services will need to be restarted. Just click OK to proceed.
-
Backing up files from the current workstation The first step in migrating to a new workstation would be to make sure all necessary production files and resources are backed up and copied over to the new system. Note Although it is not necessary to convert all of your documents when upgrading to the latest version, we strongly recommended doing so. It is considered "Best Practice" to convert the documents to the version installedand then re-send them to the Workflow Tools.
-
3. Click on the down pointing triangle under the Uncategorized group. 4. Select Import Plug-in and select the .dll file. l l l l l l l Import any external scripts used by the Run Script plugin, making sure they reflect the same paths as on the previous workstation Install any external application, executable and configuration files used by the External Program plugin, making sure they reflect the same paths as on the previous workstation Reconfigure local ODBC connections (i.e.
-
l l Reconfigure each of the plugins, where necessary, under Plug-in as previously. Capture OnTheGo users may want to enable the Use PHP Arrays option under Plug-in > HTTP Server Input 1. Send the configuration to the local Workflow service. Backing up Connect Resources The following resources are used by Connect and can be backed up from their respective folders: l l l l l Job Presets (.OL-jobpreset): C:\Users\ [UserName]\Connect\workspace\configurations\JobCreationConfig Output Presets (.
-
l l l l OL Connect Designer Templates , DataMapperor Package files, copied from the folder where they reside. All PostScript, TrueType, Open Type and other host based fonts used in templates must be reinstalled on the new workstation. Import all dynamic images and make sure their paths match those in the old server. Make sure the new workstation can also access network or remote images, JavaScript, CSS, JSON, and HTML resources referenced in the Connect templates.
-
the PlanetPress Capture options under Behavior >PlanetPress Capture > Use ODBC Database. 6. Start the Messenger 8 service on new server from the Workflow menu bar: Tools > Service Console > Messenger > right-click and select Start. OL Connect Send l l l As of version 8.6 the Connect Send plugins are installed automatically with Workflow. If you are using an older version, run the OL Connect Send Plug-in Installer on the new Workstation to re-install the Connect Send plugins.
-
l C:\Program Files\Objectif Lune\OL Connect\Connect Server\Server.ini l C:\Program Files\Objectif Lune\OL Connect\Connect Merge Engine\MergeEngine.ini l C:\Program Files\Objectif Lune\OL Connect\Connect Weaver Engine\WeaverEngine.ini 4. Now start the OLConnect_Server service Configuring the Server Extensions In the case where the OLConnect MySQL is installed on the new Master Server, it is important to reconnect all Server Extension systems to the new Master Server.
-
l l If you want to transfer your licenses to the new machine right away, you may ask your local Customer Care department for a 30day Transition activation code for your old machine. Upgrades cannot be activated using the automated Activation Manager. Contact your local Customer Care department. To apply the license file received from the Activation Team: 1. Ensure that all services are stopped on your old machine before activating and starting the services on the new machine.
-
Information about PlanetPress Workflow If you wish to use PlanetPress Workflow (automation) in conjunction with PlanetPress Connect, you will need to install PlanetPress Workflow 2020.1 as well. Workflow 2020.1 is provided through a separate installer which is available on CD or for download as follows: l l If you are a Customer, the installer can be downloaded from the Objectif Lune Web Activations page: http://www.objectiflune.
-
Upgrading This page provides information about Upgrading to PlanetPress Connect version 2020.1.
-
that is required by the installers of those products. If you do not have Update Client version 1.2.40 installed already, then the next time you run your Update Client it will show that there is an update available of itself to Version 1.2.40 (or later). Simply click on the “Install” icon to initiate the upgrade. For further details on how to upgrade the Update Client and update your Connect License see the Update Client 1.2.40 Upgrade Guide.
-
Note From PlanetPress Connect Version 1.2 onwards, the new version (1.1.8) of the Update Client is included by default with all setups. Users of Connect 1.0 Users of Connect version 1.0 cannot upgrade directly to Version 2020.1. This is because Connect Version 1.0 is a 32 bit version of Connect. Users must first upgrade to Version 1.1 and from there upgrade to Version 2020.1 If you are updating manually you must first upgrade to Version 1.1 before installing 2020.1.
-
current Scheduling settings for reference before proceeding with an upgrade. Backup these folders l C:\ProgramData\Objectif Lune\OL Connect\.settings\ConnectHostScope l C:\Users\[UserName]\Connect\filestore l C:\Users\[UserName]\Connect\workspace\configurations l C:\Users\ [UserName]\Connect\workspace\Designer\.metadata\.plugins\org.ec lipse.core.runtime\.settings l C:\Users\ [UserName]\Connect\workspace\Server\.metadata\.plugins\org.ecli pse.core.runtime\.
-
Upgrading from PReS Classic PReS Classic and PlanetPress Connect are very different products. Whilst PlanetPress Connect provides considerably more options for email and web output, one need not abandon existing PReS Classic print jobs. They can still be run through Connect Workflow, via the PReS Print Controls task in the Online Help of Workflow (see http://help.objectiflune.com/en/PlanetPress-workflow-userguide/2020.1/#Workflow/TasksProperties/PReS_Print_Control.html).
-
IMPORTANT: If you owned them, you must also upgrade your Imaging modules to use the new version. l l l PlanetPress Capture is still supported in PlanetPress Workflow 2020.1 but only with documents created with the PlanetPress Suite Design 7. PlanetPress Connect Designer. This is a design tool based on completely new technology. It is not backwards compatible and therefore cannot open PlanetPress Suite Design 7 documents.
-
computer, you should consider having at least 16GB of RAM available. See "System requirements" on page 31. Distributed installation or not You can decide to install PlanetPress Connect modules all on the same computer or have each module on a different computer. Reasons for this could be: l l There is insufficient memory in the computer currently running PlanetPress Workflow 2020.1 to also run PlanetPress Connect Server.
-
Create new documents and integrate them into your workflow at your own pace You can start benefiting from the innovative technology of the new PlanetPress Connect Designer right away by designing new documents, or re-doing existing ones at your own pace. You can also now: l l l Use the new DataMapper to easily map any input data into a clean data model that any designer person can use.
-
l Service configuration l Access manager configuration l Custom plug-ins l PlanetPress Fax settings l PlanetPress Image settings l PlanetPress Search profiles l Printer activation codes l PlanetPress Capture database l PlanetPress Capture pen licenses l Custom scripts l Content of your virtual drive l PlanetPress Messenger configuration 5. If you installed PlanetPress Workflow 2020.
-
7.
-
8. Then select the product from which you wish to upgrade: 9.
-
10.
-
11. After that you will need to get the activation file for your product. To obtain your activation, download the PlanetPress Connect installer from the Web Activation Manager (http://www.objectiflune.com/webactivationmanager/), follow the instructions for the installation using the serial number provided to you. You can activate your license through the Web Activation Manager. 12.
-
PlanetPress Workflow tool to which you want to send the PlanetPress Design document. How to perform a Workflow migration What do you need to consider when upgrading from PlanetPress Suite 7 to PlanetPress Connect Workflow 2020.1 on a new computer? Installing and Activating Workflow 2020.1 on a new computer Points to consider: l l l l Before installing, be sure to read "Installation and Activation" on page 34.
-
from the PlanetPress Suite Designer Help > Printer Activation menu option. When the "Activate a printer" dialog is launched, right click within it and select the Export context menu option, then save the file on the new computer. Double clicking on the .pac file will then activate all of your printers on the new computer. l l Login to our Web Activation Manager (www.objectiflune.com/activations) using your customer number and password to get your Printer Activation Codes.
-
computer: "C:\ProgramData\Objectif Lune\PlanetPress Suite 7\PlanetPress Watch\Documents" 2. Copy all the PlanetPress Suite 7 Documents and Compiled forms (*.ptk and *.ptz) from the Documents folder on the PlanetPress Suite computer and paste them into the equivalent folder on the Connect Workflow Computer. The PlanetPress Suite 7 folder would be "C:\ProgramData\Objectif Lune\PlanetPress Suite 7\PlanetPress Watch\Documents". The PlanetPress Connect Workflow 8 folder will be "C:\ProgramData\Objectif Lune\Plan
-
Make sure that you copy only the custom plug-ins. Alternatively, you can download custom plug-ins from http://planetpress.objectiflune.com/en/suite/resources/support onto the new computer. Once you've copied your PlanetPress Suite Workflow configurations to Connect Workflow, you can confirm their availability through the Plug-in Bar Uncategorized category. There you will find all the Custom plug-ins that have been installed.
-
l l l l l Manually install all external executables that will be referenced by the Connect Workflow processes in the configuration file. If possible, retain the local path structure as used on the older installation. If the Windows "TCP/IP Print Server" service is running on the new computer, it is recommended that you disable the Server so that it does not interfere with the PlanetPress LPD/LPR services. If you are using images from a virtual drive, copy the entire contents of "C:\ProgramData\Objectif
-
How to perform a Capture migration This page provides information on how to conduct a proper migration of a Capture solution. For information about Capture see: http://capture.objectiflune.com/en/howitworks. These steps must be executed after a proper Workflow Migration has been completed. Instructions on how to do such can be found here: "How to perform a Workflow migration" on page 80. Failure to do so will result in unexpected problems.
-
"C:\ProgramData\Objectif Lune\PlanetPress Workflow 8\PlanetPress Watch\capture" and overwrite the existing database. Note Prior to PlanetPress Suite 7.6, all Capture patterns, documents and several other details were contained within the one single database. As of PlanetPress Suite 7.6 a separate database has been used for the patterns alone (PPCaptureDefault.mdb). 5. Copy the contents of this folder: "C:\ProgramData\Objectif Lune\PlanetPress Suite 7\PlanetPress Watch\DocumentManager" to this folder: "C:\
-
to the old computer will be lost unless the steps to migrate are reproduce again. Once a Pen has been docked and the data transfer done, its memory is wiped, thus rending the parallel mode very hard to produce. It is not impossible, but describing how it can be done is beyond the scope of this migration article. Steps to migrate: 1. Update existing installation to PlanetPress Suite version 7.6 if not already done. 2. Install PlanetPress Connect Workflow 2020.1 on new computer. 3.
-
2. Select Messenger in the tree list, right click and select Stop from the context menu. Note These steps must be done for both PlanetPress Suite Workflow 7 and PlanetPress Connect Workflow 8. 5. Copy the file PPCaptureDefault.mdb from this folder on the PlanetPress Suite 7.6 computer: "C:\ProgramData\Objectif Lune\PlanetPress Suite 7\PlanetPress Watch\capture" to this folder on the new PlanetPress Connect Workflow 2020.1 computer: "C:\ProgramData\Objectif Lune\PlanetPress Workflow 8\PlanetPress Watch\c
-
> Service Console). 2. Select Messenger in the tree list, right click and select Start from the context menu options. 9. Contact your local Objectif Lune activation team and transfer any Pen(s) licenses across. Server Configuration Settings This chapter describes configuring the PlanetPress Connect Server. The Connect Server settings are maintained by the Connect Server Configuration utility tool which is installed alongside PlanetPress Connect.
-
l Engines preferences l "Automatic Restart Settings" on page 100 l "Hardware for Digital Signing preferences" on page 833 l "Language preferences" on page 101 l "Logging preferences" on page 835 l "Parallel Processing preferences" on page 101 Connection preferences Background The Connection preferences are a way to control precisely how to connect to the PlanetPress Connect Connect Server. This preference page was added in Connect 2018.2 to simplify management of HTTP communication with Connect.
-
Note This does not limit the number of requests that can be received, just how many are processed in parallel. Additional requests are buffered and are processed as capabilities allow. The default setting is twice the number of processing cores available to the computer. This can be expanded, if the limitation is deemed a bottleneck. l Dedicated Internal Connection checkbox: Set the internal connection HTTP communication setting values. These settings are purely for Connect inter-engine communication.
-
Settings for these engines are made in the Connect Server Configuration tool (see "Server Configuration Settings" on page 89). Connect allows for the parallelization of jobs. This means you can allocate 1 or more engines to process jobs. The number of each type of engine is configurable, as well as the amount of Merge engines than can work together on the same job (determined by job size: small, medium or large) and at what maximum speed.
-
l l The processing power of your machine. How many cores it has determines how many engines can be launched (see "Launching multiple engines" on the facing page). The size and number of jobs of one kind that need to be handled, sequentially or simultaneously. In other words, your use case. By allocating processing power to jobs of different sizes you can make the setup match your usage situation (see "Allocating processing power to jobs" on page 96).
-
In situations where Print and Email and/or Web output are created at the same time, only the Merge engines that create Email/Web output count towards the maximum number of Licensed tasks for that type of output. Spare speed units are distributed proportionally Since the number of engines is configurable, and jobs may run concurrently, the number of engines in use may not match the exact number of available Licensed tasks.
-
1. Open the Connect Server Configuration utility tool (see "Server Configuration Settings" on page 89). 2. Under Parallel Processing, go to the Content Creation tab and set the number of Merge engines for the various tasks. 3. Go to the Output Creation tab and set the Reserved Weaver (Output) engines. See "Deciding how many engines of each type to launch" below. 4. Click Apply or Apply and Close. It is advised that you do not configure more engines than can be backed by actual processing power.
-
When the database is installed on a system with a slow hard drive, adding a DataMapper engine may not increase the overall performance. Weaver engine Adding extra Weaver (Output) engine(s) might be useful when large Print jobs are to be run simultaneously with smaller Print jobs. Memory per engine By default, each engine is set to use up to a predetermined amount of RAM. To make optimum use of a machine's capabilities it might be useful to increase the amount of memory that the various engines can use.
-
The first step in this process is to define the size of small, medium and large jobs. Job size Connect lets you define job sizes by setting the maximum number of pages a job can have and still be considered a small job, and what the minimum number of pages a job can have in order to be considered large. Jobs that fall between the small and large jobs are medium jobs.
-
handled at the same time by that kind of engine, because there are only so many engines (and speed units) available. Note When each individual record in a job is composed of a very large number of pages, the Memory per engine setting and the machine's hard drive speed are probably more important than the number of Merge engines, since one record cannot be split over multiple cores (see "Memory per engine" on page 96).
-
may have to wait (or wait longer). However, if the server receives many web requests then having engines reserved for HTML output can help performance. l l By reserving a number of parallel engines for Print jobs of a certain size (see "Number of parallel engines per Print job" on page 97). More parallel engines will make them run faster, but they will have to wait (longer) if the required number of engines isn't available when they come in.
-
Batch processing. In a batch processing situation, jobs don't have to be handled simultaneously. All jobs - whether they are big and small - are processed one after another. Every job should be handled as quickly as possible. It is therefor recommended to assign the maximum number of engines and target speeds to all jobs. Do not reserve engines for certain jobs. Web requests. In online communication, response times are critical.
-
l l Daily restart period begin: Only available if Daily restart in period selected. Enter the daily start time for the time window in which automatic restarts will be scheduled to occur. Daily restart period end: Only available if Daily restart in period selected. The end of the daily time window in which the automatic restarts are scheduled to occur. Memory limit Enter the memory limit for individual Engines.
-
Parallel Processing properties (Designer Preferences) Preset selection (Designer Preferences) Only the Custom setting is applicable to the Designer Preferences, so this option is always selected and the field made read-only. Content Creation Tab (Designer Preferences) A Tab with data that relates solely to Content Creation. The options are: l l Total Merge engines configured read only display: This is a read only entry that shows the total number of Merge engines available.
-
l Additional engine every (records) entry: This controls how many Merge engines are used for a Content Creation task. It means that for every additional 'x' records in the task, an additional Merge engine will be used. For example, with the default 100 record threshold, tasks with 1-100 records will be assigned 1 Merge engine, tasks with 101-200 get assigned 2 merge engines, tasks with 201-300 get assigned 3 merge engines, and so on. Note These entries aren't applied instantaneously. There is often a lag.
-
l l l l l l l Default - Basic settings that are good for running most things. Single jobs have preference over multi-tasking, however. Batch Print - Best settings for processing jobs, one by one, in a sequential, first in first out (FIFO) order. On demand Print - Best settings for processing many small print jobs simultaneously. On demand - Use when serving web pages, sending emails, and printing many on demand jobs simultaneously. Connect Send - Settings optimized for use with Connect Send.
-
l Multi tasking group: When starting a new Content Creation task, the task will immediately commence if there is a Merge engine available. How many Merge engines to use is based on the number of records in the input data. Select from the following options: l Optimize per task: This runs each task with as many Merge engines as needed (until engines are exhausted). Using this option means that Merge engines will not be reassigned when new tasks come in. This option is better suited for batch processing.
-
number, not because it has been proven to have any significant value. It means that on an average system (i.e., less than 10 Merge engines) any decently sized task is allowed to use all Merge engines. It also assumes that using more than one Merge engine for less than 100 records will probably not make a big enough difference to throughput speed. Obviously, there are situations where these assumptions will not apply.
-
If only the single Weaver Engine is configured in the Engines preferences page, then this whole tab will be disabled. l l Licensed speed limit (pages per minute): This read only entry shows the current license speed limitations, in pages per minute. The speed limitations are determined by your Connect license. This information is to help you choose what settings would make sense when assigning the “Target speed” values later in the Tab.
-
Output Creation tasks. This it to prevent large jobs from using all available engines and blocking small or medium jobs from running. Since Weaver engines cannot switch tasks, such behaviour can only be achieved through reserving engines for small and/or medium jobs. Engines may be reserved both for small, and for medium sized jobs. Engine reservations are not required for either though. l l l Small job (engines): Optionally enter the number of Weaver engines you wish to reserve for Small jobs.
-
l Small job (PPM): Enter the target speed for Small jobs, in Pages Per Minute (PPM). l Medium job (PPM): Enter the target speed for Medium jobs, in Pages Per Minute (PPM). l Large job (PPM): Enter the target speed for Large jobs, in Pages Per Minute (PPM) The entire licensed speed limit will always be distributed among jobs when running jobs simultaneously. After assigning a target speed, any remaining licensed speed will be distributed throughout any simultaneous jobs by a ration of the target speed.
-
Warning It is highly recommended to keep security enabled and change the password on any server that accessible from the web. If these precautions are not taken, data saved in the server may be accessible from the outside! l l l l l Enable server security: Enable to add authentication to the REST server. - When enabled, the same username and password (which cannot be blank) must be entered in any remote Connect Designer that links to this Server.
-
Connect Updates failing due to Microsoft Visual C++ 2017 Redistributable product Certain updates to Connect 2019.2 from earlier Connect versions are failing due to an issue with two specific Microsoft Visual C++ Redistributable packages. These two versions of the Visual C++ Redistributables remove a registry entry which the Connect installer uses to determine whether or not it needs to install the Microsoft Visual C++ 2015 Redistributable. These two versions are: l MSVC++ 2017 v14.14.26405.
-
To get around the problem, please close and reopen the plugin. The problem only occurs on the initial opening, and should work fine thereafter. The OL Connect 2019.1 license update does not cater for existing AFP input licenses AFP Input is an add on option for OL Connect licenses. Unfortunately, the update to the 2019.1 version of the OL Connect license does not cater for existing AFP input licenses.
-
period of prolonged and intensive processing this can result in a degradation in performance, with the whole database slowing down as it struggles to clean itself up. In Connect terms the effect can be felt as the Data Mapper and/or Job Creation progressively slowing down. To cure this issue, it is recommended that you periodically run manual maintenance on the backend database.
-
Job Creation Presets: External Sorting change introduced in 2018.2 Versions prior to 2018.2 did not correctly save the line end characters for external sort configurations in Job Creation Presets, which meant the job could not be externally sorted. This issue has been fixed in version 2018.2. However, Job Creation Presets created with an earlier version may still have the wrong line end character for external sorting.
-
All charts l l l Legend position: The position of the legend is not converted. It defaults to 'left' in a converted chart. Rows are series/Columns are series: Only one type of data structure for detail tables is supported in the new version: the one that corresponds to the former Columns are series setting (with which charts display one series per record, one bar/point per data field). After conversion to 2018.
-
Minor differences in PCL output introduced in 2018.1 The browser component (Mozilla Gecko) used in the WYSIWYG editor of the Designer was updated for Connect 2018.1. This allows use of new CSS properties, such as flexbox. However this update could lead to increased output file sizes for some PCL jobs. This is generally not a cause for concern, however there might be some associated increase in processing times, as well as some minor differences in the output.
-
Print Output: Booklet Impositioning changes introduced in 2018.1 When Booklet Impositioning is enabled, all pages within a document need to be changed to duplex prior to Impositioning . The method for duplexing jobs has been changed to now always combine existing pages into the front and backsides of sheets, rather than adding empty backsides to any simplex pages. The result is that now every document in the job becomes a booklet without any empty pages between the first page and the last page.
-
1. Go to the .ini files for the Designer and Server Config: l C:\Program Files\Objectif Lune\OL Connect\Connect Designer\Designer.ini l C:\Program Files\Objectif Lune\OL Connect\Connect Server Configuration\ServerConfig.ini 2. Change the language parameter to the required one under Duser.language=en | es | de | fr | it | ja | ko | pt | tw | zh Only one of the above language tags should be selected. Once saved, Connect will appear in the selected language at next start-up.
-
Available Printer Models Note that only the single Printer Model (Generic PDF) will appear on the Advanced page of the Print Wizard by default. To add additional printer models click on the settings entry box. button next to the Model selection Note that the descriptions of some of the printers were updated in version 1.2 meaning that if you had version 1.n installed, you may find that the same printer style appears twice in the list, but with slightly different descriptions.
-
Warning Important Note: The Designer itself and Proof Print do not use processes that run as services and they may find local files with non-UNC paths which can lead to the false impression that the resources are correct. Using Capture after installing Workflow 8 If PlanetPress Connect Workflow 8 is installed alongside PlanetPress Suite Workflow 7, Capture can no longer be used within Workflow 7. The plugins are now registered uniquely to Workflow 8 and the Messenger for Workflow 7 is taken offline.
-
Merge/Weaver engines when printing The print operation in the Designer will automatically detect whether the Merge\Weaver engines are available and display a message for the user to retry or cancel if not. Once the Merge/Weaver engine becomes available and the user presses retry the print operation will proceed as normal. This message can also occur in the following circumstances: l If the server is offline and you are not using Proof Print. l On some occasions before the Print Wizard opens.
-
VIPP Output Some templates set up with landscape orientation are being produced as portrait in VIPP. It can also sometimes be the case that text and images can be slightly displaced. These are known issues and will be addressed in a later release of Connect. Magic Number changes when installing Docker Installing Docker on a system where Connect has already been installed may impact Connect's licensing mechanism and require reactivation.
-
recommended that any anti-virus application be stopped prior to uninstalling PlanetPress Connect, as otherwise the Connect uninstallation might not work correctly. Impacts upon other applications and services l l The Uninstall will terminate the installed Server / MySQL service(s). The following applications / services should be stopped in a controlled fashion, before running the PlanetPress Connect Uninstall: 1. PlanetPress Connect 2. Connect products on remote systems which refer to this MySQL database.
-
Note If an error occurs during uninstallation or after/when re-installing Connect after uninstalling it, please see: Problems during a Connect installation or version upgrade in Connect's Knowledge Base (https://help.objectiflune.com/en/kbconnect/#KB/FAQ/OL%20Connect/KB2002.htm).
-
General information Connect consists of visible and invisible parts. The invisible parts process the Connect job to provide the actual output. They are introduced to you in the topic: "Connect: a peek under the hood" below. For information about Connect logging, see "Log files" on page 130. For a list of all file types used in Connect, see: "Connect file types" on page 132.
-
The Workflow server The Workflow server (also referred to as the 'Watch service') executes processes independently, after a Workflow configuration has been uploaded and the services have been started. The Workflow server can run only one configuration at a time. There are a number of services related to Workflow.
-
tool. The Workflow Service Console lets you start and stop the different services, except the Connect server, and see their log files (see Workflow Service Console). Note that Workflow isn't limited to Connect functionality. It was originally developed as part of the PlanetPress Suite. Many of the plugins in the Workflow configuration tool are older than Connect. They were left in for compatibility reasons, even though they aren't all useful or usable within Connect.
-
The Connect Server Configuration tool lets you change the settings for the Connect server, the engines and the service that cleans up the database and the file store. These settings can also be made in the preferences of the Designer. The Connect database The Connect database is the database back-end used by Connect itself when processing jobs. It can be either the MySQL instance provided by the Connect installer, or a pre-existing (external) instance (see "Database Considerations" on page 19).
-
The engines DataMapper engine/s. A DataMapper engine extracts data from a data file. The number of DataMapper engines is configurable (Engines preferences). Merge engine/s. A merge engine merges data with a template using the scripts in the template, in order to create (Print,Email or Web) content items. The number of merge engines is configurable (see Engines preferences): it can be increased depending on the capacity of the machine that runs the solution (see "Performance considerations" on page 28).
-
Printing and emailing from the Designer To print or send email from within the Designer, the PlanetPress Connect service has to be running. The service is started automatically when the Designer starts, but it may not be running if the Connect Server and the Designer are installed on different computers. The PlanetPress Connect service can be found on the Services tab in the Task Manager. For a proof print the Connect server is not used. Proof printing is always done locally, by the Designer.
-
Every time output is generated, the Designer and/or Connect Server and any engines involved in the operation produce their own log files. Each component writes its log files to a dedicated subfolder of the Log folder. Merge engines write to the logs/Mergeengine folder, Weaver engines to the logs/Weaverengine folder, DataMapper engines to the logs/Datamapperengine folder, Server to the logs/Server folder, and so forth. Note that actions of the Cleanup service are only logged in the Server's log file.
-
l l The Designer's logging preferences are set via the Designer; see: "Logging preferences" on page 835. The Connect Server's settings are maintained by the Connect Server Configuration utility tool; see "Server Configuration Settings" on page 89. The logging level that is set applies to the Server as well as the engines. The Designer's log messages are also displayed in the Messages pane (see "Preflight Results and Messages" on page 1031).
-
l l l l .OL-package: A transfer file used to package one or many of the above files (the data model being part of both the template and the data mapping configuration). Created by using the File > Package dialog. (See "Package dialog" on page 955.) .OL-script: One or more Designer scripts. Scripts personalize the output of a template. They are either added via wizards (see "Personalizing content" on page 762) or selfwritten (see "Writing your own scripts" on page 843).
-
OL Connect projects An OL Connect project is an automated process, or combination of processes, in which the Connect Server and Database are used. (For an overview of the architecture of the OL Connect software, see "Connect: a peek under the hood" on page 125). Typically, an OL Connect project aims at automating (part of) a company's communication with its customers, suppliers, or other parties.
-
Wizards" on page 968 in the online help or the Project Wizards overview video on the OL Learn website. Typically, in an OL Connect project there is a number of Workflow processes that communicate with the Connect Server, Database and/or File Store through one or more of the specially developed OL Connect tasks. For help on building these Workflow processes see "Workflow processes in OL Connect projects" on page 178 and "OL Connect tasks" on page 179.
-
There is an introductory Project Wizards overview video on the OL Learn website. For generic information about Connect solutions and their components, see "OL Connect projects" on page 134. Note The projects require that the Connect Server and Connect Workflow be installed on the local machine. These are the projects that can be installed with a wizard. l l Print promotional jobs.
-
and PDF. In order to create the PDF, the data are merged with a Connect template. (See: "Project Wizard: COTG Timesheets" on page 144.) Project wizard: Basic Email The Basic Email project wizard creates an OL Connect project that sends emails with two attachments: a Return and Refund Policy (PDF) which is the same for all emails, and a delivery note (PDF) which is attached to the email dynamically. The email has a mailto link.
-
Testing and running the project Once the project wizard has finished the installation, the project is ready to be tested. 1. If the templates and data mapping configurations haven't been sent to Workflow yet, do that first (see "Sending files to Workflow" on page 429). This requires that the Workflow service is running (see Starting the Workflow service in Workflow's Online Help). 2. Locate the Workflow configuration in the project folder and open it in OL Connect Workflow. 3.
-
Project details The email template The email's design is in the EM_BASIC Email Message template. It contains one Email section (see "Email templates" on page 499). Styling is done via style sheets (see "Local formatting versus style sheets" on page 718). The style rules are in the context_htmlemails_styles.css file. Note how they use HTML tags, IDs and classes to select elements. (See also: "Selectors in Connect" on page 864.
-
"Variable Data" on page 777.) l l The To and Subject scripts apply to email fields. (Click Email Fields at the top of the email to expand all email fields.) For information about this kind of scripts, see: "Email header settings" on page 503. Finally, there are two custom scripts: l The Personalize Support link script adds the order number to the 'support team' link (which is a mailto link). The Year script puts the current year in the footer.
-
The data mapping configuration The Workflow process uses a data mapping configuration, made with "The DataMapper" on page 194: EM_BASIC Data. To open the data mapping configuration, open the Designer, select File > Open from the menu and browse to the Configurations\Resources folder. This data mapping configuration will of course only work with the appropriate data files. It was designed for XML files that are structured like this file: Sample Data.xml (in the Configurations\Resources\Data folder).
-
To see the script, click on the DeliveryNote field in the Data Model pane at the right; then take a look at the Step Properties pane (in the middle). To see where the property is defined, click the Preprocessor step on the Steps pane (at the left); then look at the Properties section on the Step Properties pane. Customizing the project A project is a great starting point for building an OL Connect solution. This part explains how to make changes to the project.
-
Note If the input data is JSON, you don't need a data mapping configuration: JSON data can be used in a template as is. See: "Adding JSON data from a JSON file" on page 775. However, if you want the data to be saved in the OL Connect database, put the XML/JSON Conversion plugin before the Send to Folder task to convert the JSON to XML, and create an XML data mapping configuration to extract the data.
-
Workflow configuration The current Workflow configuration is very simple. In reality, a process that generates email output will be part of a larger project, in which, for example, invoices are produced in a separate process, stored in a folder and attached to an email at a later time. For general information about processes in Workflow see About Processes and Subprocesses, in the Online Help of Workflow.
-
Finally, you need a valid COTG account, Repository ID and password. You could use dummy data to create the Project Wizard and finish the installation, but you won't be able to test the project. For more information about the options, see: "COTG Timesheets - Project Wizard" on page 970. Tip If you own PlanetPress Connect or PReS Connect, free COTG trial licenses may be available to you; see http://www.captureonthego.com/en/promotion/.
-
Note The process is pre-configured to use the sample data file, which comes with the project, when it runs in Debug mode. Alternatively you could copy the sample data file to the In folder. 5. Launch the COTG app and log in using the COTG account that you entered in the Project Wizard. 6. In the app, open the Repository and download one of the forms. 7. From the app's Library, open the form. 8. Enter data and draw a signature. 9. Submit the form.
-
Tip Hover over the name of a script in the Scripts pane to highlight parts of the template that are affected by the script. l l l The guid script adds data to the guid field. This is a hidden field. It is only visible in the Source view. The result of the form action script is added to the form's action attribute. To see how that is done, double-click the script; then click Options. The Year script puts the current year in the footer of the page. This is a custom script.
-
COTG Timesheet Form The COTG Timesheet Form data mapping configuration is designed to extract data from the sample data file (Sample Data.xml). The configuration also adds two fields to each record, using JavaScript: a unique ID (guid) and a field that contains the action of the Form. Note that the COTG account is the same in all of the records in the sample data. It is inserted into the sample data by the Project Wizard.
-
l l l The Create Web Content task merges the record with the COTG Timesheet Form template. The Send to Folder task saves the form to the Forms folder in the project folder, using the value of one variable as the file name. Finally, the Output to Capture OnTheGo task sends information about the form to the COTG Server. Double-click the task to see how variables are used in its settings. The Delete task is an Output task that does nothing, actually; it doesn't even remove anything.
-
Customizing the project A project is a great starting point for building an OL Connect solution. This part explains how to make changes to the project. Do you intend to expand the project into a solution where Workflow runs on a different machine that also has a different regional setting? Then indicate the desired encoding in the Designer preferences (see "Project Wizard deployment settings" on page 840) before installing the project.
-
The Send to Folder step will now write the input data - the job file - to a file in the Workspace\Debug folder. When you select the file as sample file (on the Debug ribbon), it can be used to debug the process. Tip The saved file can be used to create a data mapping configuration. The report Using different data in the report requires changing the COTG Timesheet Report template (see "Personalizing content" on page 762).
-
Workflow configuration To transform the project into a real solution, the Workflow configuration has to be adapted in two important respects. l l The timing and manner of the production of forms will need to change. The Input task of the cotg_ts_deploy_form process must be adapted to the actual input data. You will also need to create an appropriate data mapping configuration for that data, which probably means saving the input as sample data first (see "Saving input as sample data" on page 150).
-
Installing the project Select File > New > Project Wizards > Print Promotional Jobs from the menu to start the Print Promotional Jobs Project Wizard. (See also: "Promotional Print Jobs - Project Wizard" on page 972.) Note In order to use the project, OL Connect Server and OL Connect Workflow must be installed on the local machine. The wizard lets you select the folder in which you want the solution to be installed.
-
In Debug mode, the first Input task is skipped and the process is executed using a sample data file. This project is pre-configured to use the file: Sample Data.xml. A successful test run results in a subfolder in the Workspace\Out folder, named after the current month and year. The Print output is written to that subfolder. It consists of one file that should have the proper file extension.
-
l l l l The Promo script shows or hides a paragraph (with the ID 'promo') depending on whether the customer's address is in Montréal. (See: "Showing content conditionally" on page 787.) The year script changes the year in the conditional paragraph to the current year. This script only has to look for @year@ in an element that has the ID 'promo', instead of in the entire letter, which makes it run faster. The Dynamic Signature script switches the signature, with a file name based on a data field.
-
The Project Wizard installs six Output Creation Presets; two for each type of output. Per output type, all settings in the Output Creation Presets are the same, except one: Print Virtual Stationery. The ones that have this option enabled will include the Media - the Virtual Stationery - in the output. The other presets will not print the Media. Only the selected Output Creation Preset is put to use in the Workflow configuration.
-
Both the Folder Capture and the Send to Folder task read the project's Workspace path from a global variable. The value of that variable is set by the Project Wizard when it installs the project. Customizing the project A project is a great starting point for building an OL Connect solution. This part explains how to make changes to the project.
-
Template There are countless ways to customize the template to meet your exact requirements. You could, for example: l Add text, images and other elements (see "Content elements" on page 604) l Change the layout (see "Styling and formatting" on page 718) l Change the "Media" on page 481 l Change the "Master Pages" on page 478 l Add sections (see "Print context" on page 454) In order to further personalize the letter, you need to open your data mapping configuration.
-
1. Select File > Output Creation Presets from the menu 2. Click the Import button and browse to the Configurations\Resources\Output presets folder to select the preset. All of the presets provided by the wizard save the output to one file. You might want to save the output to a number of files, for instance, one per customer. The Transactional Print Jobs project shows you how to do that.
-
The selected folder's path is saved to a global variable in the Workflow configuration (see "Workflow configuration" on page 163). That variable is used in the settings of the Capture Folder task. The path is also copied to the Output Creation Presets which are used in the Create Output tasks. Testing and running the project Once the Project Wizard has finished the installation, the project is ready to be tested. 1. Locate the Workflow configuration in the Configurations\Workflow folder and open it in OL Co
-
Project details The invoice template The invoice is designed in the PR_TRAN Invoice template. It contains one Print section (see "Print sections" on page 459) and one Master Page (see "Master Pages" on page 478). The Media (virtual stationery) is included in the output - it is printed on the page's background , according to a setting in the Output Creation Presets. Styling is done via style sheets (see "Local formatting versus style sheets" on page 718). The style rules are in the context_print_styles.
-
script shows how to add data using the replace() method (see https://www.w3schools.com/jsref/jsref_replace.asp). Note that this is a native JavaScript function. Functions that are only available in Designer scripts are listed in the "Designer Script API" on page 1248. Dynamic Table The table in the invoice is a Dynamic Table. It is filled and expanded dynamically by the scripts in the Products folder. To learn how to insert and edit such a table, see "Dynamic Table" on page 793.
-
All other print settings are in the three Output Creation Presets. These are used by the Create Output tasks in the Workflow process. To see the exact settings, open an Output Creation Preset in the Designer: first select File > Output Creation Presets from the menu; then click the Import button and browse to the Configurations\Resources\Output presets folder to select the preset.
-
This project's Workflow configuration contains just one process. It is a typical OL Connect Print process (see "Print processes with OL Connect tasks" on page 184), with the difference that it does not have one Create Output task, but three. Each of them uses its own Output Creation Preset (see "Print settings" on page 162).
-
Note If the input data is JSON, you don't need a data mapping configuration: JSON data can be used in a template as is. See: "Adding JSON data from a JSON file" on page 775. However, if you want the data to be saved in the Connect database, let the XML/JSON Conversion plugin convert the JSON to XML and create an XML data mapping configuration to extract the data. Template There are countless ways to customize the template to meet your exact requirements.
-
Send the Workflow configuration to the server (see Saving and sending a Workflow Configuration in Workflow's Online Help). Print output To save the output to another type of file, or to send it to a printer, you must change the Output Creation Presets. Output Creation Presets are edited in the Designer. 1. Select File > Output Creation Presets from the menu. 2. Click the Import button and browse to the Configurations\Resources\Output presets folder to select the preset. 3.
-
Installing the project From the menu, select File > New > Project Wizards > Submitting Data with Web Forms to start the wizard. See also: "Submitting Data with Web Forms - Project Wizard" on page 974.) Note In order to use the project, OL Connect Server and OL Connect Workflow must be installed on the local machine. The wizard lets you select the folder in which you want the solution to be installed. In the selected folder, the Project Wizard will create two subfolders: Configurations and Workspace.
-
Saving input as sample data Testing a process in Debug mode is only possible with a sample data file. The process is preconfigured to use the Sample Data.xml file located in the Configurations\Data folder. To create your own sample data file: 1. Locate the Workflow configuration in the Configurations\Workflow folder and open it in Connect Workflow. 2. Select the process. 3. Enable the Send to Folder step (step 2 in the process). 4.
-
The scripts in the Thank you folder only affect the thank_you Web page; on the form Web page, nothing matches their selectors. Tip Hover over the name of a script in the Scripts pane to highlight parts of the template that are affected by the script. l l l Most of the scripts in the Thank you folder directly insert data that were submitted via the Web form; see "Inserting variable data directly (drag-and-drop)" on page 778.
-
The Delete task is an Output task that does nothing, actually; it doesn't even remove anything. However, this step is useful when running the project step by step in Debug mode. When it is followed by another task, the Create Web Content task returns its output to the Workflow process, where it can be viewed (click View as HTML). The data mapping configuration To extract the submitted data from the job file (the request XML), the process uses the data mapping configuration: WEB_FORM Data.
-
3. Upload the Workflow configuration to the server (see Saving and sending a Workflow Configuration in Workflow's Online Help) and let the process save the input data to a file (see "Saving input as sample data" on page 168). 4. Use the saved file to add the new data to the data mapping configuration (see "Opening a data mapping configuration" on page 200). Send the data mapping configuration to Workflow. 5.
-
Wizard" on page 515. Workflow configuration Serving the two web pages could also be achieved using separate processes, but in fact it is more efficient to have a single process, as activity needs to be monitored for each process. In real life the submitted data will probably not be stored in the Data Repository, but used differently. This means that the Push to Repository task will need to be replaced by the appropriate tasks, but that won't change the way the submitted data is retrieved.
-
installed on the local machine. The wizard lets you select the folder in which you want the solution to be installed. In the selected folder, the Project Wizard will create two subfolders: Configurations and Workspace. The project's resource files are saved to the Configurations folder. The Workspace folder is used for debugging or running the solution. It has an In folder that may be used to monitor incoming data and an Out folder to write output files to.
-
1. Locate the Workflow configuration in the Configurations\Workflow folder and open it in Connect Workflow. 2. Select the process. 3. Enable the Send to Folder step (step 2 in the process). 4. Send the Workflow configuration to PlanetPress Workflow service (see Saving and sending a Workflow Configuration) and run it again, with a custom name value. The Send to Folder step will now write the input data - the job file - to a file in the Workspace\Debug folder.
-
l l The My name is script looks for an element that has the ID: hero. Inside that element it looks for the text: @name@ and replaces that with either the default name ("John Doe") or the name given in the URL. The Year script puts the current year in the footer. For more information about writing scripts, see: "Writing your own scripts" on page 843. Tip You don't have to write a script yourself if you just want to insert some data directly into the template.
-
To create the data mapping configuration, the input data needed to be saved to a file first (see "Saving input as sample data" on page 173). The sample data file is located in the Configurations\Data folder, but you will also see it when you open the data mapping configuration itself: For more information about data mapping configurations see "The DataMapper" on page 194. Customizing the project A project is a great starting point for building an OL Connect solution.
-
Web page There are countless ways to modify the template. You could add text, images and other elements (see "Content elements" on page 604) and change the layout (see "Styling and formatting" on page 718). In order to further personalize the web page, open your data mapping configuration (or JSON data, if the input data will be in that format; see "Adding JSON data from a JSON file" on page 775) and use the data fields to personalize the page. (See: "Personalizing content" on page 762.
-
For general information about processes in Workflow see About Processes and Subprocesses, in the Online Help of Workflow. Workflow processes in OL Connect projects About Workflow processes A Workflow configuration consists of one or more processes. Each of these processes waits until it is time to run or until it receives the necessary input, and then does its job. A process is made up of tasks (also referred to as plugins). In the Workflow configuration tool they are divided into groups.
-
Common OL Connect Workflow processes In an OL Connect project there are typically a number of Workflow processes that communicate with the Connect Server and/or database through one or more of the OL Connect tasks. These are the most common Workflow processes in Connect solutions. l l l l Print process.
-
This topic describes the available OL Connect tasks, which are commonly used in Workflow processes in OL Connect projects (see "Workflow processes in OL Connect projects" on page 178). Data extraction The Execute Data Mapping task is likely to appear in a lot of OL Connect Workflow processes. It generates a record set in the OL Connect database by executing a data mapping configuration on a data source. Output creation Merging the records with a template is the job of one of the following tasks.
-
The Create Preview PDF task generates a PDF preview for a single record as fast as possible. This preview is typically used for PDF previews embedded in web pages. PlanetPress Suite Documents The Create PDF/VT task creates PDF/VT files from a PlanetPress Suite Document (created with PlanetPress Design). This PDF/VT is compatible with the Create Print Content task directly, without the use of an OL Connect template (PDF/VT mode).
-
configuration tool has three tasks to that end: the File Store - Upload File task, File Store Download File task, and File Store - Delete File task. Capture OnTheGo Workflow processes A Capture OnTheGo solution requires no less than three basic processes in a Workflow configuration: l l l One process that generates a document (most often, a form), stores it and notifies the COTG app of the document's existence. Note that this process doesn't send the actual document.
-
Tip An easy way to create a Connect email project, including the Workflow configuration and the files that it needs, is to use a Project Wizard. See "Project wizard: Basic Email" on page 137. The structure of an OL Connect email process In an OL Connect Email process only one plugin is essential: the Create Email Content plugin. The Create Email Content task creates a set of emails, using the Email context in a Connect template, and sends them to the email server.
-
l l A template with an Email context. (See "Creating a template" on page 423.) If the email should contain variable data, you might need to make a data mapping configuration (see "Creating a new data mapping configuration" on page 196). If the input is going to be JSON data, you could add them to the design using a JSON file (see "Adding JSON data from a JSON file" on page 775).
-
l l l l The Execute Data Mapping task, or the Retrieve Items task. The Execute Data Mapping task extracts data from the job data file and puts them in a record set. This task works according to the instructions in a data mapping configuration, made with the DataMapper (see "Data mapping configurations" on page 195). The Retrieve Items task retrieves records from the OL Connect database. The Create Print Content task. This task merges data with a template, resulting in Print Content Items.
-
In addition, the process may use: l l l A data mapping configuration, or a data model at the very least, if the documents should contain variable data. (See "Creating a new data mapping configuration" on page 196.) A Job Creation Preset. (See "Job Creation Presets Wizard" on page 1137.) A Job Creation Preset defines where the output goes and makes it possible to filter and sort records, group documents, and add metadata. An Output Creation Preset. (See "Output Creation Presets Wizard" on page 1154.
-
If the Input task is a Server Input task, that task will return the output of the process - the web page - to the caller. The HTTP Action of the Server Input task determines how the process is triggered. If, for example, the HTTP Action is /hello, the process will be invoked when the Workflow server receives a request for a resource called hello.
-
l l A template with a Web context. (See "Creating a template" on page 423.) If the web page should contain variable data, you might need to make a data mapping configuration (see "Creating a new data mapping configuration" on page 196). If the input is going to be JSON data, you could add them to the design using a JSON file (see "Adding JSON data from a JSON file" on page 775).
-
l l Phase 1: Content is created by merging a print template with data. Newly created print content items are always automatically saved in the Connect database1. Information about the set of items (the "content set"), including the Content Set ID, gets stored in the database as well. Phase 2: Print content items are retrieved from the Connect database using the Retrieve Items task. The Create Job and Create Output tasks transform these items or sets into one or more print jobs.
-
How to retrieve: selection methods The Retrieve Items task can retrieve items/sets by ID or based upon conditions. Retrieving items/sets by ID New print content items are automatically saved in the Connect database when the Create Content task creates them. The task returns the IDs of those items, as well as the ID of the content set, to the Workflow process via Metadata (see About Metadata).
-
property to retrieve the content set in its entirety (i.e. all content items that belong to that content set); it isn't possible to retrieve individual content items using that property. Properties added to a content set are not propagated to the individual items in that content set. To label both a set and the items in it, use the Set Properties task twice. Note Data field values and properties of items in the Connect database are also used when sorting the output.
-
as well as the ID of the content set to the process via the Metadata. Using those IDs, the Set Properties task can either set properties on all new Content Items or on the Content Set that was just created. Use two consecutive Set Properties tasks to set properties on both levels. l Through a Post Pagination script in the template. (See "Post Pagination Scripts" on page 894 and "contentitem" on page 1391.
-
Batching/Commingling tab of Retrieve Items task The Batching/Commingling tab of the Retrieve Items task allows you to group and sort print content on two levels. You can: l l Bundle content items into "documents" (mail pieces) and sort the items within each document. Put documents in "groups", and define how documents are sorted within a group. Note that this tab is only available when the Retrieve Items task is configured to retrieve content items - not content sets.
-
The DataMapper The DataMapper is the tool to create a data mapping configuration. Data mapping configurations are used to extract data and transpose that data into a format that can be shared amongst different layouts and outputs created with the OL Connect Designer and Workflow. The original data, located in a file or database outside of OL Connect, is called a data source.
-
3. Build the data mapping workflow. A data mapping workflow always starts with the Preprocessor step and ends with the Postprocessor step. You can add as many steps as you like and edit the Data Model of the extracted data as required. See "Data mapping workflow" on page 217 and "The Data Model" on page 258. What's next? Use the data mapping configuration in the Designer module to create templates for personalized customer communications. To learn more, see "The Designer" on page 421.
-
Creating a new data mapping configuration A new data mapping configuration can be made with or without a wizard. When you open a data file with a DataMapper wizard, the wizard automatically detects a number of settings. You can adjust these settings. Next, the wizard automatically extracts as many data fields (or metadata, in case of a PDF/VT or AFP file) as it can, in one extraction step. Without a wizard you have to make the settings yourself, and configure the extraction workflow manually.
-
l From the File menu 1. Click the File menu and select New. 2. Click the Data mapping Configuration drop-down and select Files and then the file type: l Comma Separated Values or Excel (CSV/XLSX/XLS), l Microsoft Access l PDF, PS, PCL or AFP l Text l XML. 3. Click Next. 4. Click the Browse button and open the file you want to work with. 5. Click Finish.
-
the DataMapper won't either. If the original is a PDF, it is recommended to find an alternative way to get it in the system instead of going through a print operation. l Rotated pages in a PDF are supported (if rotated 0/90/180/270 degrees). The Extract step will be able to extract data from horizontal and vertical lines of text on rotated pages.
-
The steps to take with the wizard depend on the file type. See: l "Using the wizard for CSV and Excel files" on page 201 l "Using the wizard for databases" on page 203 l "Using the wizard for PDF/VT or AFP files" on page 206 l "Using the wizard for XML files" on page 208 Generating a counter Instead of creating a data mapping configuration for a certain type of data file, you may create a data mapping configuration that only contains a series of sequential numbers.
-
l l l l l l Increment Value: The value by which to increment the counter for each record. For example, an increment value of 3 and starting value of 1 would give the counter values of 1, 4, 7, 10, [...] Number of records: The total number of counter records to generate. This is not the end value but rather the total number of actual records to generate. Padding character: Which character to add if the counter's value is smaller than the width. Width: The number of digits the counter will have.
-
Using the wizard for CSV and Excel files The DataMapper wizard for CSV and Excel files helps you create a data mapping configuration for such files. The wizard automatically detects delimiters and extracts all data in one extraction step. The wizard interprets each line in the file as a record. If your data file contains transactional data, you will probably want more lines to go in one record and put the transactional data in detail tables. The wizard cannot create detail tables.
-
Note Excel files saved in "Strict Open XML" format are not supported yet. After selecting the file, take a look at the preview to ensure that the file is the right one and the encoding correctly reads the data. Click Next. For an Excel file you can make the following settings: l l l First row contains field names: Uses the first row of the Excel sheet as headers, which automatically names all extracted fields. Sheet: Select the sheet from which the data should be extracted.
-
Tip The Sort on option, combined with the Stop data mapping option of the "Action step" on page 255, allows to process only a group of items without having to examine all records. (See also: "Action step properties" on page 340.) Verify that the data are read properly. Finally click Finish. All data fields are automatically extracted in one extraction step. Using the wizard for databases The DataMapper wizard for database files helps you create a data mapping configuration for a database file.
-
4. Use the drop-down to select the database type. 5. Click Next. Wizard settings for a database file After opening a database file with a wizard there are a number of settings to make, depending on the database type (see below). On the last page of the dialog, click Finish to close the dialog and open the actual data mapping configuration. Note After creating the initial data mapping configuration you may use a custom SQL query via the Input Data Settings; see "Settings for a database" on page 221.
-
l Sort on: Select a field on which to sort the data, in ascending (A-Z) or descending (Z-A) order. Note that sorting is always textual. Even if the selected column has numbers, it will be sorted as a text. Microsoft Access l l l Password: Enter a password if one is required. Table name: The selected database is a set of related tables composed of rows and columns corresponding respectively to source records and fields. Select a table from which you want to extract data.
-
JDBC Note Since JDBC can connect to multiple types of databases, a specific database driver and path to this driver's JAR file must be specified. l l l l l l l l JDBC Driver: Use the drop-down to select which JDBC Driver to use for the database connection. JAR file path: Enter a path to the JAR file that contains the appropriate driver for the database. Server: Enter the server address for the database server.
-
Tip To extract information from the metadata in the extraction workflow itself, you have to create a JavaScript extraction (see "Using scripts in the DataMapper" on page 371 and "extractMeta()" on page 393). If the PDF doesn't contain any metadata, each page is a new record - in other words, a boundary is set at the start of a new page -, which is exactly what happens when you open the file without a wizard. You can open a PDF/VT or AFP file with a wizard using the Welcome screen or the File menu.
-
Click Finish to close the dialog and open the actual Data Mapping configuration. On the Settings pane, you will see that the boundary trigger is set to On metadata. The selected metadata fields are added to the Data Model. Note Extracting data from a PDF that comes from a Windows printer queue (a PDF converted to PostScript, converted back to PDF by an Input task in Workflow) might not work (see the Connect Knowledge Base.
-
3. From the Using a wizard pane, select XML. 4. Click the Browse button and open the XML file you want to work with. Click Next. l From the File menu 1. In the menu, click File > New. 2. Click the Data mapping Wizards drop-down and select From XML File. 3. Click Next. 4. Click the Browse button and open the XML file you want to work with. Click Next. After selecting the file, you have to set the split level and trigger type: l l XML Elements: This is a list of node elements that have children nodes.
-
This topic's intention is to provide you with a method to make LincPDF take these advanced settings into account, so the generated PDF can be correctly read in the DataMapper. Note The method described in this topic can only be done using PlanetPress Workflow. Requirements To be able to import PCL input files, you will need the PCL Input license, in addition to PlanetPress Connect. To check if you have a PCL Input license: 1. Open the Connect Software Activation module. 2.
-
1. Add a local variable to your process and name it lincPDFOptions. 2. Add another local variable named workingDir and give it a default Windows path (for example: C:\PCL2PDF\). 3. Add a plugin to capture the PCL File. You may use any input plugin that imports the PCL file into the process, such as Folder Capture, LPD Input, etc. 4. Using the Change Emulation plugin, change the Emulation to ASCII.
-
(default: 0). PDF Author -dAuthor:$s string PDF document’s author (default: null). PDF Title -dTitle:$s string PDF document’s title (default: filename). 6. Next, use the External Program plugin to convert the PCL to PDF with the above % {lincPDFOptions} options. In the General tab: l l l l l Set the Executable file to: C:\Program Files\Objectif Lune\OL Connect\LPDFConv\Bin\LincPDFC.exe Set the Parameters to: -i"%F" -o"%{workingDir}\Temp\%O.
-
the Workflow log. 7. Save the output of LincPDFC using the –o folder specifier in the parameter (% {workingDir}\Temp, in this case.) In another Workflow process, import the created PDF with the Folder Capture input plugin, specifying the output folder of the previous process (%{workingDir}\Temp in the example) as input folder, and %O.pdf as the file mask.
-
Once you have the PDF as job file, you may pass it to the Execute Data Mapping plugin for further processing. LincPDFC Options To view the available options that can be set in LincPDF, run the executable (LincPDFC.exe) in a command prompt window. It will display a help message with available options.
-
/*Open Windows Command Prompt Change directory cd C:\Program Files\Objectif Lune\OL Connect\LPDFConv\Bin C:\Program Files\Objectif Lune\OL Connect\LPDFConv\Bin\LincPDFC.exe LincPDF for Command-Line, Version 2.6.6.14 Copyright (c) 2001-2007 Lincoln & Co., a division of Biscom, Inc. Usage: LincPDF -iInput.PCL [-oOutput.
-
-dTitle:$s : PDF Title -dSubject:$s : PDF Subject -dAuthor:$s : PDF Author -dKeywords:$s : PDF Keywords -dVersion:num : PDF Version (multiply by 10) Page Setup: -pWidth:num : Page Width (required only if Page Type is Custom) -pHeight:num : Page Height (required only if Page Type is Custom) -pXOff:num : Page X Offset (see also Measurement) -pYOff:num : Page Y Offset (see also Measurement) -pMeasure:num : Page Measurement (0-inch, 1-mm, 2-point) -pOrient:num : Page Orientation (0-Portrait, 1-Landscape) -pTyp
-
-yCopyContents : Enable Copying Text and Graphics from Document -yUse128Bit : Use 128-bit Encryption -yAssembleDocument : Enable Assemble Document (128-bit encryption only) -yExtractText : Enable Text and Graphics Extraction (128-bit encryption only) -yLowResolutionPrint : Enable Lower-level Resolution Printing (128-bit encryption only) Tips ---------------------------------------------------. using quotation mark for complicated string, for example, -dKeywords:"key1, key2" .
-
after the Data Mapping workflow has completed ("Postprocessor step" on page 256). When you create a new data mapping configuration, these steps are added automatically, but they don't actually do anything until you configure them. In between the Preprocessor and Postprocessor step, the workflow can contain as many steps as needed to extract the required data.
-
Editing steps The properties of each step in the extraction workflow become visible in the Step properties pane when you select that step in the Steps pane. The name of each step is shown in the Steps pane. You can change it under Description in the Step properties pane. The other properties are different per step type; see "Steps" on page 246. Rearranging steps To rearrange steps, simply drag & drop them somewhere else on the colored line in the Steps pane.
-
If any errors are encountered in one or more records, an error message will be displayed. Errors encountered while performing the extraction workflow on the current record will also be visible on the Messages tab. Note How many records are displayed in the Data Viewer (200, by default) is specified in the Record limit on the Settings pane. Data source settings After opening a data file you have to make a number of settings to make sure that the source data is interpreted and grouped the way you want.
-
fields, even if the field delimiter is the semicolon. For an explanation of all the options, see: "CSV file Input Data settings" on page 313. Settings for an Excel File For an Excel file you have to specify which sheet to use. You can also set how many lines should be skipped, if the first row contains field names or not, and how the data should be sorted. See: "Excel file Input Data settings" on page 314. Excel has its own way to display dates.
-
width if you are still working with old line printer data; etc. It is important that pages be defined properly. This can be done either by using a set number of lines or using a string of text (for example, the character “P”), to detect on the page. Be aware that this is not a Boundary setting; it detects each new page, not each new record. For an explanation of all the options, see: "Text file Input Data settings" on page 316.
-
PDF file) or changing (a customer ID, a user name, etc). To define a more complex trigger, you can write a script (see "Setting boundaries using JavaScript" on page 373). A new record cannot start in the middle of a data field, so if the trigger is something in the data, the boundary will be set on the nearest preceding natural delimiter. If for instance in a PDF file the text "Page 1 of" is used as the trigger, the new record starts at the page break before that text.
-
template. In the Data Model, data are converted to the native data type. Dates, for example, are converted to a DateTime object. How they are displayed in the Data Model depends on the current operating system's regional settings. Properties and runtime parameters A data mapping configuration's properties hold data that can be used throughout the data mapping workflow to compare against in conditions or to complement the existing data.
-
1. Select the Preprocessor step on the Steps pane. 2. On the Step properties pane, under Properties, click the Add button . See "Properties" on page 331 for an explanation of the settings for properties. Accessing properties and runtime parameters There are different ways to access properties and runtime parameters in a data mapping workflow. l l l Property-based fields. A property-based field is filled with the value of a property. See "Property-based field" on page 265. Step settings.
-
Before you start Data source settings Data source settings must be made beforehand, not only to make sure that the data is properly read but also to have it organized in a record structure that meets the purpose of the data mapping configuration (see "Data source settings" on page 220). It is important to set the boundaries before starting to extract data, especially transactional data (see "Extracting transactional data" on page 231).
-
Tip In a PDF or Text file, use the Drag icon Data Model. to drag selected data into the With this method, a new Extract step will only be added to the extraction workflow if another Extract step is not currently selected. Otherwise, the field is added to the currently selected Extraction step. Dragging data into an existing field in the Data Model will replace the data. The field name stays the same. Drop data on empty fields or on the record itself to add new fields.
-
If you tick the Append values to current record option when several steps are extracting the same field, the step will error out. Extracting data into multiple fields When you select multiple fields in a CSV or tabular data file and extract them simultaneously, they are put into different fields in the Data Model automatically. In a PDF or Text file, when multiple lines are extracted at the same time, they are by default joined and put into one field in the Data Model.
-
l Set the data type, data format and default value of each field. l Modify the extracted data through a script. l Delete a field. All this can be done via the Step properties pane (see "Extract step properties" on page 333), because the fields in the Data Model are seen as properties of an Extract step. See also: "Fields" on page 263. Testing the extraction workflow The extraction workflow is always performed on the current record in the data source.
-
extraction (Condition step). They can also be used to control the workflow through conditions and loops. Right-clicking on a data selection displays a contextual menu with the actions that can be performed with that selection or the steps that can be added with it. That menu also displays the keyboard shortcuts. Text or PDF file To select data in a Text or PDF file, click on a starting point, keep the mouse button down, drag to the end of the data that needs to be selected and release the mouse button.
-
XML File XML data is displayed as a tree view inside the Data Viewer. To get a better overview you can also collapse any XML level. In this tree view you can select nodes just like files in the Windows Explorer: keep the Ctrl key pressed down while clicking on nodes to select or deselect them, or keep the Shift key pressed down to select consecutive nodes. You can select multiple fields even if those fields are in different nodes. Note The Goto step is rarely used in XML extraction workflows.
-
Detail tables are created when an Extract step is added within a Repeat step. The Repeat step goes through a number of lines or nodes. An Extract step within that loop extracts data from each line or node. How exactly this loop is constructed depends on the type of source data. For more information about detail tables, multiple detail tables and nested detail tables, see "Detail tables" on page 303. From a CSV file or a Database The transactional data (also called line items) appear in multiple rows.
-
1. Select a field in the column that contains the first line item information. 2. Right-click this data selection and select Add Repeat. This adds a Repeat step with a GoTo step inside it. The GoTo step moves the cursor down to the next line, until there are no more lines (see "Goto step" on page 250). 3. (Optional.) Add an empty detail table via the Data Model pane: right-click the Data Model and select Add a table. Give the detail table a name. 4. Select the Repeat step on the Steps pane. 5.
-
The extraction step is placed inside the Repeat step, just before the GoTo step. From an XML file The transactional data appears in repeated elements.
-
1. Right-click one of the repeating elements and select Add Repeat. This adds a Repeat step to the data mapping configuration. By default, the Repeat type of this step is set to For Each, so that each of the repeated elements is iterated over. You can see this on the Step properties pane, as long as the Repeat step is selected on the Steps pane. In the Collection field, you will find the corresponding node path.
-
2. (Optional.) Add an empty detail table via the Data Model pane: right-click the Data Model and select Add a table. Give the detail table a name. 3. Select the Repeat step on the Steps pane. 4. Extract the data: inside a repeating element, select the data that you want to extract. Then right-click the selected nodes and select Add Extraction, or drag & drop them in the Data Model. When you drag & drop data on the name of a detail table in the Data Model pane, the data are added to that detail table.
-
1. Select an element in the first line item. 2. Right-click on the selection and select Add Goto. The Goto step will move the cursor to the start of the first line item. 2. Add a Repeat step where the loop must stop. 1. In the line under the last line item, look for a text that can be used as a condition to stop the loop, for example "Subtotals", Total" or "Amount". 2. Select that text, right-click on it and select Add Repeat. The Repeat step loops over all lines until the selected text is found. 3.
-
1. Select the start of the Repeat step on the Steps pane. 2. Look for something in the data that distinguishes lines with a line item from other lines (or the other way around). Often, a "." or "," appears in prices or totals at the same place in every line item, but not on other lines. 3. Select that data, right-click on it and select Add Conditional. Selecting data - especially something as small as a dot - can be difficult in a PDF file.
-
4. (Optional.) Add an empty detail table to the Data Model: right-click the Data Model and select Add a table. Give the detail table a name.
-
5. Extract the data (see "Adding an extraction" on page 226). When you drag & drop data on the name of a detail table in the Data Model pane, the data are added to that detail table. Dropping the data somewhere else on the Data Model pane, or using the contextual menu in the Data Viewer, creates a new detail table, with a default name that you can change later on (see "Renaming a detail table" on page 303).
-
Note In a PDF or Text file, pieces of data often have a variable size: a product description, for example, may be short and fit on one line, or be long and cover two lines. To learn how to handle this, see "Extracting data of variable length" on the facing page. 6. Extract the sum or totals. If the record contains sums or totals at the end of the line items list, the end of the Repeat step is a good place to add an Extract step for these data.
-
Extracting data of variable length In PDF and Text files, transactional data isn't structured uniformly, as in a CSV, database or XML file. Data can be located anywhere on a page. Therefore, data are extracted from a certain region on the page. However, the data can be spread over multiple lines and multiple pages: l l Line items may continue on the next page, separated from the line items on the first page by a page break, a number of empty lines and a letterhead.
-
Using a Condition step or Multiple Conditions step Using a Condition step ("Condition step" on page 251) or a Multiple Conditions step ("Multiple Conditions step" on page 254) one could determine how big the region is that contains the data that needs to be extracted. In each of the branches under the Condition or Multiple Conditions step, an Extract step could be added to extract the data from a particular region. The Extract steps could write their data to the same field.
-
Page 244
-
Using a script A script could also provide a solution when data needs to be extracted from a variable region. This requires using a Javascript-based field. 1. Add a field to an Extract step, preferably by extracting data from one of the possible regions; see "Extracting data" on page 225. To add a field without extracting data, see "JavaScript-based field" on page 264. 2. On the Step properties pane, under Field Definition, select the field and change its Mode to Javascript.
-
Note that this script replicates exactly what can be done in a Condition step. In cases like this, it is recommended to use a Condition step. Only use a script when no steps are sufficient to give the expected result, or when the extraction can be better optimized in a script. Steps In the DataMapper, steps are part of an extraction workflow (see "Data mapping workflow" on page 217). They contain a specific instruction for the DataMapper, for example to extract data, create a loop, or apply a condition.
-
also lets you define properties and runtime parameters that can be used throughout the data mapping workflow. For a complete overview of the settings for a Preprocessor step, see: "Preprocessor step properties" on page 329. Properties and runtime parameters A data mapping configuration's properties hold data that can be used throughout the data mapping workflow to compare against in conditions or to complement the existing data.
-
Extract step The Extract step is essential in each and every data mapping configuration. It extracts data from the data source, based on their location (a row and column in CSV or tabular data, an XPath in XML, or a region of the page in PDF and Text) or on JavaScript code. The data is stored in the record set that is the result of the extraction workflow. Fields always belong to an Extract step, but they don't necessarily all contain extracted data.
-
see: "Extracting data" on page 225. l Alternatively, right-click the Steps pane and select Add a Step > Add Extraction. Make the required settings on the Step properties pane. If an Extract step is added within a Repeat step, the extracted data are added to a detail table by default; see "Extracting transactional data" on page 231 and "Detail tables" on page 303.
-
1. On the Steps pane, select the step after which to insert the Condition step. 2. Make sure that the cursor is located where the extraction loop must start. By default the cursor is located at the top of the page or record, but previous steps in the extraction workflow may have moved it down. If necessary, add a Goto step (see "Goto step" below). This step can be skipped when the data source is an XML file. 3.
-
l l On the Steps pane, select the step after which to insert the Goto step. In the Data Viewer, select some data, right-click that data and choose Add Goto, to add a Goto step that moves the cursor to that data. Alternatively, right-click the Steps pane and select Add a Step > Add Goto. Make the required settings on the Step properties pane. Configuring a Goto step For information about how to configure the Goto step, see "Goto step properties" on page 359.
-
Adding a Condition step To add a Condition step: l On the Steps pane, select the step after which to insert the Condition step; then, in the Data Viewer, select some data, right-click that data and choose Add Conditional. In the Step properties pane, you will see that the newly added Condition step checks if the selected position (the left operand) contains the selected value (the right operand). Both operands and the operator can be adjusted.
-
(in the Step properties pane).Make a selection in the Data Viewer and click the Use selected text button in the Right Operand section. You will now be able to see whether or not the proper text is extracted by the current selection. Repeat this until you are satisfied that the proper data is being extracted.Click on the Use selection button in the Left Operand section to fill out the coordinates.The point of origin of each character is at the bottom left of each of them and extends up and to the right.
-
Rules are by default combined with AND. To change the way rules are combined, right-click "AND" in the Rule Tree, on the Step properties pane, and select OR or XOR instead. (XOR means one or the other, but not both.) Renaming a rule To rename a rule, double-click its name in the Rule Tree and type a new name. Multiple Conditions step The Multiple Conditions step is useful to avoid the use of nested Condition steps: Condition steps inside other Condition steps.
-
Adding a Multiple Conditions step To add a Multiple Conditions step, right-click the Steps pane and select Add a Step > Add Multiple Conditions. To add a case, click the Add case button to the right of the Condition field in the Step properties pane. Configuring a Multiple Conditions step For information about how to configure the Multiple Conditions step, see "Multiple Conditions step properties" on page 356.
-
l l l l Execute JavaScript code. Set the value for a record property. Record properties are defined in the Preprocessor step; see "Preprocessor step" on page 246. Stop the processing of the current record and move on to the next one. Normally an extraction workflow is automatically executed on all records in the source data. By stopping the processing of the current record, you can filter out some records or skip records partially.
-
l Select the Postprocessor step on the Steps pane. l On the Step properties pane, under Postprocessor, click the Add button l . Under Postprocessor definition, add the script. Postprocessor tasks must be written in JavaScript (see "Using scripts in the DataMapper" on page 371 and "DataMapper Scripts API" on page 368). Configuring the Postprocessor step For an explanation of the settings for post-processors, see "Postprocessor step properties" on page 363.
-
mapping workflow. In order to test post-processors you must execute them manually by clicking the Apply button in the Post-processor step properties (see "Postprocessor step properties" on page 363). Note that in the DataMapper and Designer, only one data record is active at any given time. Therefore, the changes made by the post-processes are only visible on the current data record (i.e. the one currently displayed).
-
About records A record is a block of information that may be merged with a template to generate a single document (invoice, email, web page...) for a single recipient. It is part of the record set that is generated by a data mapping configuration. In each record, data from the data source can be combined with data coming from other sources. Records can be duplicated by setting the number of copies in a script (see "record" on page 399). Duplicates are not shown in the Data Model.
-
Note l l Imported Data Model fields always overwrite existing field properties when the field name is the same (although they will still be part of the same Extract step). Nonexistent fields are created automatically with the appropriate field settings. The import is case-insensitive. All imported data model fields are marked as required in the Data Model (indicated with an asterisk (*) next to their names).
-
To change the order in which data are extracted, see "Renaming and reordering fields in an extraction step" on page 266. Moving fields To move a field, a group of fields or a detail table, you can simply drag and drop it to some other place in the Data Model. Alternatively, you can right-click the field, group or detail table and select one of the options in the Move menu, to move it up or down within the list or group. Fields cannot be moved into another table.
-
In Workflow, when a data mapping configuration is used to extract data from a data source (see "Data mapping configurations" on page 195), the extracted data is stored in a record set in the OL Connect database. Adding fields and data via Workflow The Data Model is not extensible outside of the DataMapper. When it is used in Workflow - as part of a data mapping configuration - the contents of its fields can be updated but not its structure.
-
l Select Metadata as the data source in the Create Preview PDF plugin. Note Many of these actions can also be performed using REST calls. Please refer to PlanetPress Connect Workflow documentation for more information about the plugins involved. Fields Extracted data are stored in fields in the Data Model (see "The Data Model" on page 258). Fields can be present on different levels: on the record level or in a detail table (see "Detail tables" on page 303).
-
JavaScript-based field JavaScript-based fields are filled by a script: the script provides a value. Note that the last value attribution to a variable is the one used as the result of the expression. There is a number of ways to add a Javascript based field. Via the Steps pane 1. Make sure there is no data selection in the Data Viewer. 2. Right-click on an Extract step on the Steps pane and select Add a Step > Add Extract Field. (To add a new Extract step, select Add a Step > Add Extraction first.) 3.
-
Property-based field A property-based field is filled with the value of a property (see "Properties and runtime parameters" on page 224). Custom properties can be added via the Preprocessor step; see "Preprocessor step" on page 246. A property-based field cannot be added directly. To fill a field with the value of a property, you have to change an existing field's Mode to Properties. 1. Select the field in the Data Model. 2. On the Step properties pane, under Field Definition, change its Mode to Properties.
-
Renaming and reordering fields in an extraction step The names of fields, as well as the order of fields in an extraction step, can be changed via the properties of the Extract step that they belong to. 1. Select the Extract step that contains the fields that you want to rename. To do this you could click on one of those fields in the Data Model, or on the step in the Steps pane. 2. On the Step properties pane, under Field Definition, click the Order and rename fields button. 3.
-
Setting the data type Fields store extracted data as a String by default. The data type of a field can be changed via the properties of the Extract step that the field belongs to. 1. Select the Extract step that contains the field. You can do this by clicking on the field in the Data Model, or on the step in the Steps pane that contains the field. 2. On the Step properties pane, under Field Definition, set the Type to the desired data type. See "Data types" on page 276 for a list of available types.
-
Post function On the Step properties pane, under Field Definition, you can enter a script in the Post function field to be run after the extraction. (Click the Use JavaScript Editor button to open the Script Editor dialog if you need more space.) A Post function script operates directly on the extracted data. Its results replace the extracted data. For example, the Post function script replace("-", ""); replaces the first dash character that occurs inside the extracted string.
-
2. In the Step properties pane, under Field Definition, click the Remove Extract Field button next to the Field List drop-down. Detail tables A detail table is a field in the Data Model that contains a record set instead of a single value. Detail tables contain transactional data. They are created when an Extract step is added within a Repeat step; see "Extracting transactional data" on page 231. In the most basic of transactional communications, a single detail table is sufficient.
-
3. Click somewhere else on the Step Properties pane to update the Data Model. You will see the new name appear. Creating multiple detail tables Multiple detail tables are useful when more than one type of transactional data is present in the source data, for example purchases (items with a set price, quantity, item number) and services (with a price, frequency, contract end date, etc).
-
and you will have to rename the detail table created in each Extract step to pull the detail tables apart (see "Renaming a detail table" on page 269).
-
Nested detail tables Nested detail tables are used to extract transactional data that are relative to other data. They are created just like multiple detail tables, with two differences: l l For the tables to be actually nested, the Repeat step and its Extract step that extract the nested transactional data must be located within the Repeat step that extracts data to a detail table. In their name, the dot notation (record.services) must contain one extra level (record.services.charges).
-
a number of "details" such as movie rentals or long distance calls.
-
The services can be extracted to a detail table called record.services. The "charges" and "details" can be extracted to two nested detail tables.
-
The nested tables can be called record.services.charges and record.services.details.
-
Now one "charges" table and one "details" table are created for each row in the "services" table. Data types By default the data type of extracted data is a String, but each field in the Data Model can be set to contain another data type. To do this: 1. In the Data Model, select a field. 2. On the Step properties pane, under Field Definition choose a data type from the Type drop-down. Changing the type does not only set the data type inside the record.
-
l "HTMLString" on page 283 l "Integer" on page 283 l "Float" on page 282 l "Currency" on the facing page l "Date" on page 279 l "Object" on page 284 Note The Object data type is only available in the DataMapper module. It can be used for properties in the Preprocessor step, but not for fields in the Data Model. Boolean Booleans are a simple true/false data type often used in conditions and comparisons.
-
Note The value must be all in lowercase: true, false. Any variation in case (True, TRUE) will not work. Boolean expressions Boolean values can be set using an expression of which the result is true or false. This is done using operators and comparisons. Example: record.fields["isCanadian"] = (extract("Country") == "CA"); For more information on JavaScript comparison and logical operators, please see w3schools.com or developer.mozilla.org.
-
Note While Currency values can be set to up to 4 significant digits, only 2 are displayed on screen. Building Currency values Currency values can be the result of direct attribution or mathematical operations just like Integer values (see "Integer" on page 283). Date Dates are values that represent a specific point in time, precise up to the second. They can also be referred to as datetime values. While dates are displayed using the system's regional settings, in reality they are stored unformatted.
-
l In the user preferences ("DataMapper preferences" on page 821). l In the data source settings ("Data source settings" on page 220). l In the field properties: on the Step properties pane, under Data Format, specify the Date/Time Format. 4. For the letters and patterns that you can use in a date format, see "Defining a date/time format" below. Data format settings tell the DataMapper how to read and parse data from the data source.
-
l l ap: AM/PM string. In addition, any constant character can be included in the mask, usually to indicate date/time separators (i.e. / - :) . If one of those characters happens to be one of the reserved characters listed above, it must be escaped using the \ symbol. Note The markers that can be used when extracting dates are different from those that are used to display dates in a template (see the Designer's "Date and time patterns" on page 1262).
-
l In a Preprocessor property. To do this, go to the Steps pane and select the Preprocessor step. Then, on the Step properties pane, under Properties add a property, specify its Type as Date and put the JavaScript in the Default Value field. The use of the JavaScript Date() object is necessary when creating dates through a JavaScript expression. For more information, see w3schools - JavaScript Dates and w3schools - Date Object.
-
Building Float values Float values can be the result of direct attribution or mathematical operations just like Integer values (see "Integer" below). HTMLString HTMLStrings contain textual data that includes HTML markup. They are essentially the same as String values except in cases where the HTML markup can be interpreted. Example: Assume that a field has the value He said WOW!.
-
l l Direct attribution: Assign an integer value directly, such as 42, 99593463712 or data.extract("TotalOrdered");. Mathematical operations: Assign the result of any mathematical operation. For example: 22+51, 3*6, 10/5 or sourceRecord.property.SubTotal. For more information on mathematics in JavaScript , see w3Schools - Mathematical Operators. For more advanced mathematical functions, see w3schools - Math Object. Note When adding numbers that are not integers, for instance 4.5 + 1.
-
l Extraction: l In the Data Model, select a field. On the Step properties pane, under Field Definition set the Type to String. The field value will be extracted and treated as a string. l l JavaScript Expression: Set the desired value to any string between quotes. Example: record.fields["countryOfOrigin"] = "Canada"; Building String values String values can be made up of more than just a series of characters between quotes.
-
xsi:schemaLocation="http://www.objectiflune.com/connectschemas/Data ModelConfig http://www.objectiflune.com/connectschemas/DataModelConfig/1_0_0_ 3.xsd" xmlns:xsi="http://www.w3.
-
Example: transactional details, in a simple invoice format PAGE 288
Example: nested tables (one table into another) PAGE 289
Keyboard shortcuts This topic gives an overview of keyboard shortcuts that can be used in the DataMapper. Keyboard shortcuts available in the Designer for menu items, script editors and the data model pane can also be used in the DataMapper; see "Keyboard shortcuts" on page 1005. Although some of the keyboard shortcuts are the same, this isn't a complete list of Windows keyboard shortcuts. Please refer to Windows documentation for a complete list of Windows keyboard shortcuts.
-
Key combination Function displays the corresponding menu.) The menu can then be browsed using the Enter key, arrow up and arrow down buttons.
-
Key combination Function Ctrl + Shift + S Save all Ctrl + Shift + W or Ctrl + Shift + F4 Close all Ctrl + F5 Revert Ctrl + F7 Next view Ctrl + Shift + F7 Previous view Ctrl + F8 Next perspective Ctrl + Shift + F8 Previous perspective Ctrl + F10 Save as Ctrl + F12 Send to Workflow / Package files F4 Ignore step/Reactivate step F6 Add an Extract step F7 Add a Goto step F8 Add a Condition step F9 Add a Repeat step Page 291
-
Key combination Function F10 Add an Extract field F11 Add an Action step F12 Add a Multiple Conditions step Alt + F12 Add a Case step (under a Multiple Conditions step) Home Go to the first step in the workflow End Go to the last step in the workflow Alt + V Validate records Shift + F10 or Ctrl + Shift + F10 Open context menu Viewer pane The following key combinations activate a function in the Viewer.
-
Key combination Function Ctrl + + Zoom in Ctrl + Shift + E Switch to Editor Ctrl + F6 Next editor (when there is more than one file open in the Workspace) Ctrl + Shift + F6 Previous editor (when there is more than one file open in the Workspace) Data Model pane Key combination Function PageUp Go to previous record PageDown Go to next record Alt + CR Property page Alt + PageDown Scroll down to the last field Alt + PageUp Scroll up to the first field Steps tab Key combination Function
-
Edit Script and Expression windows The following key combinations have a special function in the Expression and in the Edit Script windows (expanded view). Key combination Function Ctrl + space Content assist (auto-complete) Ctrl + A Select all Ctrl + D Duplicate line Ctrl + I Indent (Tab) Ctrl + J Line break Ctrl + L Go to line; a prompt opens to enter a line number.
-
File Menu l l l l l l l l l l New...: Opens the dialog to create a new data mapping configuration; see "Creating a new data mapping configuration" on page 196. Open: Opens a standard File Open dialog. This dialog can be used to open Templates and data mapping configurations. Open Recent: List the most recently opened Templates and configurations. Clicking on a template will open it in the Designer module, clicking on a data mapping configuration will open it in the DataMapper module.
-
Edit Menu l Undo: Undoes the previous action. l Redo: Redoes the last action that was undone. l l l l Cut Step: Removes the currently selected step and places it in the clipboard. If the step is a Repeat or a Condition, all steps under it are also placed in the clipboard. If there is already a step in the clipboard, it will be overwritten. Copy Step: Places a copy of the currently selected step in the clipboard. The same details as the Cut step applies.
-
l l l l l l Add Goto Step: Adds a Goto step that moves the selection pointer to the beginning of the data selection. For instance if an XML node is selected, the pointer moves to where that node is located. Add Condition Step: Adds a condition based on the current data selection. The "True" branch gets run when the text is found on the page. Other conditions are available in the step properties once it has been added.
-
l l Reset Perspective: Resets all toolbars and panes to the initial configuration of the module. Preferences: Click to open the Preferences dialog. Help Menu l l l Software Activation: Displays the Software Activation dialog. See Activating your license. Help Topics: Click to open this documentation. Contact Support: Click to open the Objectif Lune Contact Page in the default system Web browser. l About PlanetPress Connect Designer: Displays the software's About dialog.
-
Filter To find a certain table, group or field in a large Data Model, start typing characters in the Filter box. This immediately narrows down the list of displayed items to all tables, groups and fields whose name contains the characters that were typed. Note that the filtering is case-insensitive. Data Model toolbar buttons : Import Data Model: Click to browse to a file that contains a Data Model. This may l be: l A Data Model file (*.OL-datamodel). l A JSON file (*.json; see the note below).
-
l l l l : Synchronize Fields and Structure: Click to synchronize the Data Model fields and structure in the currently loaded template and data mapping configuration. If you click this button when working on the data mapping configuration, the Data Model gets updated to the one in the template. If you click it when working on the template, the Data Model gets updated to the one in the data mapping configuration. : Show the ExtraData field. Note that this field is not meant to be filled via an extraction.
-
Note Rename, Delete and Set Type are only available for Data Model fields or detail tables that are not filled via an extraction. Fields and detail tables that are filled via an Extract step are to be changed (renamed, deleted etc.) via the properties of that Extract step; see: "Editing fields" on page 265 and "Renaming a detail table" on page 303. l l Rename: Click to rename the selected table, field or group. Enter the new name and click OK to rename.
-
l l l l l l l l The column on the left displays the name of the field. The column on the right displays the current value of the extracted field based on the record shown in the Data Viewer, if an Extract step has an extraction for this field (see "Extracting data" on page 225). The icon to the left of the name indicates the data type of the field (see "Data types" on page 276). A field name with an asterisk to the right indicates that this field is required.
-
l l l l Previous Record: Go to the previous record in the data sample. This button is disabled if the first record is shown. Current Record: Displays the current record or table entry. Type a record number and press the Enter key to display that record. The number has to be within the number of available records in the data sample. Next Record: Go to the next record in the data sample. This button is disabled if the last record is shown. Last Record: Go to the last record in the data sample.
-
Note A detail table’s name should always begin with ‘record.’. 3. Click somewhere else on the Step Properties pane to update the Data Model. You will see the new name appear. Creating multiple detail tables Multiple detail tables are useful when more than one type of transactional data is present in the source data, for example purchases (items with a set price, quantity, item number) and services (with a price, frequency, contract end date, etc).
-
To create more than one detail table, simply extract transactional data in different Repeat steps (see "Extracting transactional data" on page 231). The best way to do this is to add an empty detail table (right-click the Data Model, select Add a table and give the detail table a name) and drop the data on the name of that detail table.
-
Nested detail tables Nested detail tables are used to extract transactional data that are relative to other data. They are created just like multiple detail tables, with two differences: l l For the tables to be actually nested, the Repeat step and its Extract step that extract the nested transactional data must be located within the Repeat step that extracts data to a detail table. In their name, the dot notation (record.services) must contain one extra level (record.services.charges).
-
a number of "details" such as movie rentals or long distance calls.
-
The services can be extracted to a detail table called record.services. The "charges" and "details" can be extracted to two nested detail tables.
-
The nested tables can be called record.services.charges and record.services.details.
-
Now one "charges" table and one "details" table are created for each row in the "services" table. The Data Viewer The Data Viewer is located in the middle on the upper half of the DataMapper screen. It displays the data source that is currently loaded in the DataMapper, specifically one record in that data. Where one record ends and the next starts is determined in the Data Source settings (see "Record boundaries" on page 222).
-
l l l Hide/Show datamap : Click to show or hide the icons to the left of the Data Viewer which displays how the steps affect the line. Hide/Show extracted data : Click to show or hide the extraction selections indicating that data is extracted. This simplifies making data selections in the same areas and is useful to display the original data. Lock/Unlock extracted data : Click to lock existing extraction selections so they cannot be moved or resized.
-
Messages pane The Messages pane is shared between the DataMapper and Designer modules and displays any warnings and errors from the data mapping configuration or template. At the top of the Message pane are control buttons: l Export Log: Click to open a Save As dialog where the log file (.log) can be saved on disk. l Clear Log Viewer: Click to remove all entries in the log viewer. l Filters: Displays the Log filter (see "Log filter" below).
-
Settings pane Settings for the data source and a list of Data Samples and JavaScript files used in the current data mapping configuration, can be found on the Settings tab at the left. The available options depend on the type of data sample that is loaded. The Input Data settings (especially Delimiters) and Boundaries are essential to obtain the data and eventually, the output that you need. For more explanation, see "Data source settings" on page 220.
-
l l Ignore unparseable lines: Ignores any line that does not correspond to the settings above. Skip empty lines: Ignore any line that has no content. Note that spaces are considered content. l Sort on: Select a field on which to sort the data, in ascending (A-Z) or descending (Z-A) order. Note that sorting is always textual. Even if the selected column has numbers, it will be sorted as a text.
-
average character in the font. l l l l Line spacing: Determines the spacing between lines of text. The default value is 1, meaning the space between lines must be equal to at least the average character height. Paragraph spacing: Determines the spacing between paragraphs. The default value is 1.5, meaning the space between paragraphs must be equal to at least 1.5 times the average character height to start a new paragraph. Magic number: Determines the tolerance factor for all of the above values.
-
l l l Encoding: Defines what encoding is used to read the Data Source ( US-ASCII, ISO8859-1, UTF-8, UTF-16, UTF-16BE or UTF-16LE ). Sort on: Allows to select a field on which to sort the data, in ascending (A-Z) or descending (Z-A) order. Note that sorting is always textual. Even if the sorting column has numbers, it will be sorted as a text. With a Custom Query, this option is not available. Skip empty lines: Ignore any row that has no content, e.g. only nulls or empty strings.
-
l On text: Triggers a new page in the Data Sample when a specific string is found in a certain location. l Word to find: Compares the text value with the value in the data source. l Match case: Activates a case sensitive text comparison. l l l Location: Choose Selected area or Entire width to use the value of the current data selection as the text value. Left/Right: Use the spin buttons to set the start and stop columns to the current data selection (Selected area) in the record.
-
l The XPath must start with = l The entire JavaScript statement must be enclosed in curly brackets: { ... } l Any other curly brackets that are not part of the JavaScript code must be escaped with a backslash. Single line comments (//...) in the code are not supported. Note that since the XPath is a string, the return value of the JavaScript statement will be interpreted as a string.
-
Boundaries Boundaries are the division between records: they define where one record ends and the next record begins; for an explanation see "Record boundaries" on page 222. CSV, Excel or Database file boundaries Since database data sources are structured the same way as CSV and Excel files, the options for these file types are identical. l l l Record limit: Defines how many records are displayed in the Data Viewer. This does not affect output production; when generating output, this option is ignored.
-
PDF file boundaries For a PDF file, Boundaries determine how many pages are included in each record. You can set this up in one of three ways: by giving a static number of pages; by checking a specific area on each page for text changes, specific text, or the absence of text; or by using an advanced script. l l Record limit: Defines how many records are displayed in the Data Viewer. To disable the limit, use the value 0 (zero).
-
Text file boundaries For a text file, Boundaries determine how many 'data pages' are included in each record. These don't have to be actual pages, as is the case with PDF files. The data page delimiters are set in the "Text file Input Data settings" on page 316. l l l Record limit: Defines how many records are displayed in the Data Viewer. This does not affect output production; when generating output, this option is ignored. To disable the limit, use the value 0 (zero).
-
l l Delimiters before/after: Defines the boundary a certain number of data pages before or after the current data page. This is useful if the text triggering the boundary is not located on the first data page of the record. l Operator: Selects the type of comparison (for example, "contains"). l Word to find: Compares the text value with the value in the data source.
-
l l Field: Displays the fields and (optionally) attributes in the XML element. The value of the selected field determines the new boundaries. Also extract element attributes: Check this option to include attribute values in the list of content items that can be used to trigger a boundary. Data samples The Data Sample area displays a list of all the imported Data Samples that are available in the current data mapping configuration.
-
l l Reload : Reload the currently selected Data Sample and any changes that have been made to it. Set as Active : Activates the selected Data Sample. The active data sample is shown in the Data Viewer after it has gone through the Preprocessor step as well as the Input Data and Boundary settings. Editor Data Format The Editor Data Format setting is only available for Excel files. l Date Display Format: This setting specifies how dates must be displayed in the Data Viewer.
-
l Add : Add a new external library. Use the standard Open dialog to browse and open the .js file. l Delete l Replace l Reload to it. : Remove the currently selected library from the data mapping configuration. : Open a library and replace it with the contents of a different js file.
-
SQL Query Designer The SQL Query Designer is used to design a custom SQL query to pull information from a database. It can be opened by clicking the Input Data. l l l l Custom SQL button on the Settings pane, under Tables: Lists all tables and stored queries in the database. Custom Query: Displays the query that retrieves information from a database. You may use variables and properties in the query, to make the selection dynamic. See "Using variables and properties in an SQL query" below.
-
l Properties that have their scope set to "Automation variable". These are retrieved via automation.variables(see "Objects" on page 378), for example automation.variables.FieldList. Properties that have their scope set to "Each record" and can not be used because the SQL query is executed before any record is created. For the same reason, variables declared in other Steps can not be used. Example = SELECT {automation.variables.FieldList} FROM {automation.jobInfo.
-
Viewing step details Hovering over the task shows a tooltip that displays some of the details of that step. To see all details for a step, click on the step and take a look at the Step properties pane ("Step properties pane" on the next page). Clicking on any Extract step in the Steps pane highlights any area in the Data Viewer from which it extracts data. You can also click on the Preprocessor step to select all the steps in the workflow to show a complete map of all the extracted data.
-
l Copy/Paste Step: To copy a step, right-click on it and select Copy Step or use the button in the Toolbar. If the step is Repeat or Condition, all steps under it will also be placed in the clipboard. To paste the copied step at its destination, right-click the step in the position before the desired location and select Paste Step, or use the Toolbar. button in the Step properties pane The Step Properties pane is used to adjust the properties of each Step in the process (see "Steps" on page 246).
-
Description This subsection is collapsed by default in the interface, to give more screen space to other important parts. Name: The name of the step. This name will be displayed on top of the step's icon in the Steps pane. Comments: The text entered here will be displayed in the tooltip that appears when hovering over the step in the Steps pane. Fixed automation properties The Fixed automation properties subsection lists all the fixed runtime parameters available from PlanetPress Workflow.
-
access these property inside of any JavaScript code within the data mapping configuration, use automation.properties.OriginalFilename. l l ProcessName: This property contains the name of the process that is currently executing the data mapping configuration and is equivalent to the %w variable in the process. To access this property inside of any JavaScript code within the data mapping configuration, use automation.properties.ProcessName.
-
l l l Entire Data: These properties are statically set at the start of a job, before anything else. They cannot be changed once they have been set, in other words they are global constants. They are mostly useful for static information such as folder locations or server addresses. Each Record: These properties are evaluated and set at the beginning of each source record.
-
l l Name: The name to identify the Preprocessor task. Click this field to rename the Preprocessor task. Type: The type of Preprocessor task. Currently there is only one type available: script. The buttons to the right can be used to add, remove and reorder the tasks and to apply them to the current data file. The Export button exports the current data file in its current state. Preprocessing may cost a lot of time when the data file is very large.
-
extractions within the same loop. This ensures that, if multiple extracts are present, only one detail table is created. Field Definition The following field definition settings are identical for all fields. l Field List: The Field List displays each of the single fields that belong to the selected step in a drop-down. Fields can be re-ordered and re-named within the Order and rename fields dialog (see "Order and rename fields dialog" on page 339).
-
l Use selection: Click to use the value of the current data selection for the extraction. Note If the selection contains multiple lines, only the first line is selected. l Properties: The value of the property selected below will be the value of the selected field. l l l Property: This drop-down lists all the currently defined properties (including system properties). Custom properties can be defined in the Preprocessor step; see "Preprocessor step" on page 246.
-
Note If the selection contains multiple lines, only the first line is extracted. l Post Function: Enter a JavaScript expression to be run after the extraction. A Post function script operates directly on the extracted data, and its results replace the extracted data. For example, the Post function script replace("-", ""); would replace the first dash character that occurs inside the extracted string. l Use JavaScript Editor: Click to display the Script Editor dialog.
-
l l l l Post Function: Enter a JavaScript expression to be run after the extraction. For example replace("-","") would replace a single dash character inside the extracted string. Trim: Select to trim empty characters at the beginning or the end of the field. Type: The data type of the selected data; see "Data types" on page 276. If the selected data is split (see below), this setting is applied to the first extracted field.
-
Settings for location-based fields in an XML File These are the settings for location-based fields in an XML file. l XPath: The path to the XML field that is extracted. l Use selection: Click to use the value of the current data selection for the extraction. Note If the selection contains multiple lines, only the first line is selected. l Post Function: Enter a JavaScript expression to be run after the extraction.
-
l Currency Sign : Set the currency sign for a currency value. l Date Format : Set the date format for a date value. l l Date Language : Set the date language for a date value (ex: If English is selected, the term May will be identified as the month of May). Treat empty as 0 : A numerical empty value is treated as a 0 value. Order and rename fields dialog The Order and rename fields dialog displays the extracted fields in the currently selected Extract step.
-
l Move Up button l Move Down button : Click to move the selected field up one position. : Click to move the selected field down one position. Note The order of fields in an extraction step isn't necessarily the same as the order of those fields in the Data Model; see "Ordering and grouping fields in the Data Model" on page 260. Action step properties The Action step can run multiple specific actions one after the other in order; see "Action step" on page 255 for more information.
-
l l l Run JavaScript : Runs a JavaScript expression, giving much more flexibility over the extraction process. Skip to next record: When this option is selected, the extraction workflow stops processing the current record and moves on to the next one. If fields were already extracted prior to encountering the Action step, then those fields are stored as usual. If no fields were extracted prior to encountering the Action step, then no trace of the record is saved in the database at run time.
-
Note If the selection contains multiple lines, only the first line is selected. l l Trim: Select to trim empty characters at the beginning or the end of the field JavaScript : The result of the JavaScript Expression written below the drop-down will be the value of the extracted field. If the expression contains multiple lines, the last value attribution (variable = "value";) will be the value. See "DataMapper Scripts API" on page 368. l l l l Expression: The JavaScript expression to run.
-
l l Date Language : Set the date language for a date value (ex: If English is selected, the term May will be identified as the month of May). Treat empty as 0 : A numerical empty value is treated as a 0 value. CSV and Database Files l Property: Displays a list of record properties set in the Preprocessor step (see "Preprocessor step" on page 246). l Type: Displays the type of the property. Read only field. l Based on: Determines the origin of the data.
-
l l Use selected text: Inserts the text in the current data selection in the JavaScript Expression. If multiple lines or elements are selected, only the first one is used. Use selection: Click to use the value of the current data selection for the extraction. Note If the selection contains multiple lines, only the first line is selected. l Data Format: Data format settings tell the DataMapper how certain types of data are formatted in the data source.
-
l XPath: The path to the XML field that is extracted. l Use selection: Click to use the value of the current data selection for the extraction. Note If the selection contains multiple lines, only the first line is selected. l l Trim: Select to trim empty characters at the beginning or the end of the field JavaScript : The result of the JavaScript Expression written below the drop-down will be the value of the extracted field.
-
l Data Format: Data format settings tell the DataMapper how certain types of data are formatted in the data source. Make sure that this format matches the actual format of the data in the data source. l Negative Sign Before : A negative sign will be displayed before any negative value. l Decimal Separator : Set the decimal separator for a numerical value. l Thousand Separator : Set the thousand separator for a numerical value. l Currency Sign : Set the currency sign for a currency value.
-
The properties described below become visible in the Step properties pane when the Repeat step is selected in the Steps pane. Description This subsection is collapsed by default in the interface, to give more screen space to other important parts. Name: The name of the step. This name will be displayed on top of the step's icon in the Steps pane. Comments: The text entered here will be displayed in the tooltip that appears when hovering over the step in the Steps pane.
-
value returned by the expression must be an integer higher than 0. Note that in the event of an infinite loop, an error will only be raised after the set maximum number of iterations. l l Use JavaScript Editor: Click to display the Edit Script dialog. Collection (only with For Each): The XPath that specifies the level and (optionally) elements to select on that level. To select elements you can either use static values, e.g. ./user[@lastname="Smith"] or JavaScript statements, for example: =.
-
Note Both the Left and Right operands have the same properties. Text and PDF Files Note The Repeat Step expects lines of text in a PDF file to be horizontal (regardless of the orientation of the page). Vertical text will cause an error. l Based On: l Position: The data in the specified position for the comparison. l l l l l l l Right: The end position for the data selection. Top offset: The vertical offset from the current pointer location in the Data Sample (Viewer).
-
l JavaScript : The result of a JavaScript Expression. l l l l l l l Use JavaScript Editor: Click to display the Edit Script dialog. Use selected text: Inserts the text in the current data selection in the JavaScript Expression. If multiple lines or elements are selected, only the first one is used. Data Property: The value of a data-level property set in the Preprocessor step (see "Preprocessor step" on page 246).
-
CSV and Database Files l Based On: l Position: The data in the specified position for the comparison. l l l l l l l l l l Trim: Select to trim empty characters at the beginning or the end of the field. Value: The text value to use in the comparison. Use selected text: Uses the text in the current data selection as the Value. If multiple lines or elements are selected, only the first one is used. Field: The Extracted Record field to use in the comparison.
-
l Extractor Property: The value of an internal extractor variable: l l l Counter: The value of the current counter iteration in a Repeat step. Vertical Position: The current vertical position on the page, either in Measure (PDF) or Line (Text and CSV). Operators: l l l l l l is equal to: The two specified value are identical for the condition to be True. contains: The first specified value contains the second one for the condition to be True.
-
l JavaScript : The result of a JavaScript Expression. l l l l l l l Use JavaScript Editor: Click to display the Edit Script dialog. Use selected text: Inserts the text in the current data selection in the JavaScript Expression. If multiple lines or elements are selected, only the first one is used. Data Property: The value of a data-level property set in the Preprocessor step.
-
Condition step properties A Condition step is used when the data extraction must be based on specific criteria. See "Condition step" on page 251 for more information. The properties of a Conditon step become visible in the Step properties pane when the Condition step is selected on the Steps pane. Description This subsection is collapsed by default in the interface, to give more screen space to other important parts. Name: The name of the step.
-
Note Both the Left and Right operands have the same properties. l Based On: l Position: The data in the specified position for the comparison. l l Right (Txt and PDF only): The end position for the data selection. l Height (Txt and PDF only): The height of the selection box. l l l l l l l XPath (XML only): The path to the XML field that is extracted. l Top offset: The vertical offset from the current pointer location in the Data Sample (Viewer).
-
JavaScript Expression. If multiple lines or elements are selected, only the first one is used. l l l l Data Property: The value of a data-level property set in the Preprocessor (see "Preprocessor step" on page 246). Record Property: One of the local variables that you can create and that are reset for each document as opposed to data variables that are global because they are initialized only once at the beginning of each job.
-
Description This subsection is collapsed by default in the interface, to give more screen space to other important parts. Name: The name of the step. This name will be displayed on top of the step's icon in the Steps pane. Comments: The text entered here will be displayed in the tooltip that appears when hovering over the step in the Steps pane. Condition Left operand, Right operand The Left and right operand can be Based on: l Position: The data in the specified position for the comparison.
-
l l JavaScript: The result of a JavaScript Expression. l l l l l l l Field: The Extracted Record field to use in the comparison. Expression: The JavaScript line that is evaluated. Note that the last value attribution to a variable is the one used as a result of the expression. See also: "DataMapper Scripts API" on page 368. Use JavaScript Editor: Click to display the Edit Script dialog (see "Using scripts in the DataMapper" on page 371).
-
Operators l Case conditions are made by comparison of the two operands, left and right, using a specific Operator. l l l l l l is equal to: The two specified value are identical for the condition to be True. contains: The first specified value contains the second one for the condition to be True. is less than: The first specified value is smaller, numerically, than the second value for the condition to be True.
-
Text file l Target Type: Defines the type of jump. l Line: Jumps a certain number of lines or to a specific line. l l l l Current Position: The Goto begins at the current cursor position. l Top of record: The Goto begins at line 1 of the source record. Move by: Enter the number of lines or pages to jump. Page: Jumps between pages or to a specific page.
-
l Left: The starting column, inclusively. l Right: The end column, inclusively. l l l l Use selection: Click while a selection is made in the Data Viewer to automatically set the left and right values to the left and right edges of the selection. Expression: Enter the text or Regex expression to look for on the page. Use selection: Click while a selection is made in the Data Viewer to copy the contents of the first line of the selection into the Expression box.
-
l Left: The starting column, inclusively. l Right: The end column, inclusively. l l Use selection: Click while a selection is made in the Data Viewer to automatically set the left and right values to the left and right edges of the selection. Next occurrence of: Jumps to the next occurrence of specific text or a text pattern, either anywhere on the line or in specific columns.
-
XML File l Destination (XML files): Defines what type of jump to make: l l l l l Sibling element: Jumps the number of siblings (nodes at the same level) defined in the Move byoption. Sibling element with same name: Jumps the number of same name siblings (nodes at the same level of which the node is the same name) defined in the Move byoption. Element, from top of record: Jumps to the specified node. The XPATH in the Absolute XPATHoption starts from the root node defined by /.
-
Postprocessor The Postprocessor subsection defines what postprocessors run on the Data Sample at the end of the data mapping workflow. Each Postprocessor runs in turn, using the result of the previous one as an input. l Name: The name to identify the Postprocessor. l Type: The type of Postprocessor. Currently there is a single type available. l JavaScript: Runs a JavaScript Expression to modify the Data Sample. See "DataMapper Scripts API" on page 368.
-
Toolbar In the DataMapper module, the following buttons are available in the top toolbar. File manipulation l New: Displays the New wizard where a new data mapping configuration or a new template can be created. Open: Displays the Open dialog to open an existing data mapping configuration. l l Save: Saves the current data mapping configuration. If the configuration has never been saved, the Save As... dialog is displayed.
-
l l l l l l l l Add Extract Field: Adds the data selection to the selected Extract step, if an extract step is currently selected. If multiple lines, nodes or fields are selected, multiple extract fields are added simultaneously. Add Multiple Conditions: Adds a condition that splits into multiple case conditions. Add Action Step: Adds a step to create a custom JavaScript snippet. See "DataMapper Scripts API" on page 368 for more details.
-
If you are new to PlanetPress Connect and you don't know where to start, see "Welcome to PlanetPress Connect 2020.1" on page 15. The Welcome Screen can be reopened in two ways: l The Welcome Screen button in the "Toolbars" on page 1048. l From the Menus in Help, Welcome Screen. To go back from the Welcome Screen to the template or data mapping configuration that you were working on: l Close the Welcome Screen by clicking the cross next to the text 'Welcome' at the top.
-
l Create/Open: l l l l l Open File: Lets you open an existing template or data mapping configuration. New template: Lets you choose a Context to create a new template without a Wizard. Template Wizards: Displays a list of available Template Wizards, producing premade templates with existing demo content; see "Creating a template" on page 423. Project Wizards: Displays a list of available Project Wizards, producing a complete Connect project; see "Project Wizards" on page 968.
-
Name Description Available in scripts of type "db" on page 398 An object that allows to connect to a database. Boundaries, all steps except Goto "logger" on page 399 An object that allows to log error, warning or informational messages. Boundaries, all steps except Goto "record" on page 399 The current record in the main data set. Extract, Condition, Repeat and Multiple Conditions steps "region" on page 400 An object that defines a subsection of the input data.
-
Functions These functions are available in Boundaries and Steps scripts. Name Description copyFile() Copies a file to the target file path, replacing it if it already exists. "createGUID()" on page 409 Returns a unique 36-character string consisting of 32 alphanumeric, lower case characters and four hyphens (format: 84-4-4-12). Example: 123e4567-e89b-12d3-a456-426655440000. "createHTTPRequest ()" on page 409 Creates a new HTTP Request Object.
-
Name Description openBinaryReader() Opens a file as a binary file for reading purposes. openBinaryWriter() Opens a file as a binary file for writing purposes. openTextReader() Opens a file as a text file for reading purposes. openTextWriter() Opens a file as a text file for writing purposes. Using scripts in the DataMapper In the DataMapper every part of the extraction process can be customized using scripts.
-
The script can always be written directly in a small script area or in the Edit script dialog. To invoke this dialog click the Use JavaScript Editor button . Tip In the Edit script dialog, press Ctrl + Space to bring up the list of available JavaScript objects and functions (see Datamapper API). Use the arrow keys to select a function or object and press enter to insert it. Type a dot after the name of the function or object to see which features are subsequently available.
-
Take the following JavaScript function, for example: function myAddFunction(p1, p2) { return p1 + p2; }; If this is saved as myFunction.
-
Accessing data Data available inside each event Every time a delimiter is encountered, an event is triggered and the script is executed. The event gives the script access to the data between the current location - the start of a row, line or page - and the next delimiter. So at the beginning of the process for a PDF or text file, you have access to the first page only, and for a CSV or for tabular data, that would be the first row or record.
-
"Artist","Album","Released" "Beatles","Abbey Road",1969 "Beatles","Yellow Submarine",1969 "Led Zeppelin","Led Zeppelin 1",1969 "Led Zeppelin","Led Zeppelin 2",1969 "Beatles","Let it be",1969 "Rolling Stones","Let it bleed",1969 "Led Zeppelin","Led Zeppelin 3",1970 "Led Zeppelin","Led Zeppelin 4",1971 "Rolling Stones","Sticky Fingers",1971 Note The first line is just the header with the names of the CSV columns. The data is already sorted per year, per artist, and per album.
-
!= boundaries.getVariable("lastYear") ) { boundaries.set(); } } boundaries.setVariable("lastBand",zeBand[0]); boundaries.setVariable("lastYear",zeYear[0]); l l l l The script first reads the two values from the input data, using the createRegion() method (see: "createRegion()" on page 401). For a CSV/database data type, the parameter it expects is simply the column name.
-
Beatles Led Zeppelin Led Zeppelin Beatles Rolling Stones Led Zeppelin Led Zeppelin Rolling Stones Yellow Submarine Led Zeppelin 1 Led Zeppelin 2 Let it be Let it bleed Led Zeppelin 3 Led Zeppelin 4 Sticky Fingers 1968 1969 1969 1970 1969 1970 1971 1971 The purpose of the script, again, is to set the record boundary when EITHER the year OR the artist changes. The script would look like this: /* Read the values of both columns we want to check */ var zeBand = boundaries.get(region.
-
Settings, specify On lines as the Page delimiter type with the number of lines set to 1. When you now set the boundary Trigger to On script, the file will be processed line per line (triggering the event on each line). Paste the above code in the JavaScript expression field and click the Apply button to see the result.
-
Properties The following table lists the properties of the automation object. All properties are read-only. Property Description jobInfo Returns a ScriptableAutomation object containing Job Info 1 to 9 values from PlanetPress Workflow (see "Fixed automation properties" on page 330, and Job Info variables in the Workflow Online Help).
-
boundaries Returns a boundaries object encapsulating properties and methods allowing to define the boundaries of each document in the job. This object is available when triggering document boundaries On script. Properties The following table lists the properties of the boundaries object. Property Description currentDelim A read-only 1-based index (number) of the current delimiter in the file. In other words, the Beginning Of File (BOF) delimiter equals 1.
-
Method Description Script type setVariable () Sets a boundaries variable to the specified value, automatically creating the variable if it doesn't exist yet. Boundaries find() Method of the boundaries object that finds a string in a region of the data source file. The method returns the region in which the string was searched (PDF file) or the exact region in which the string was encountered (Text file). To check if the call to boundaries.
-
location where the match was found. This will always be a subset of the in_Region.range property. It can be used to determine the exact location where the match occurred. Use boundaries.get() to retrieve the actual text from the resulting region; see "get()" below. Example This script sets a boundary when the text TOTAL is found on the current page in a PDF file. The number of delimiters is set to 1, so the boundary is set on the next delimiter, which is the start of the next page. if (boundaries.
-
Note Boundary variables are carried over from one iteration of the Boundaries script to the next, while native JavaScript variables are not. getVariable(varName) varName String name of the variable from which the value is to be retrieved. If the variable does not exist, the value null is returned. It is considered good practice (almost mandatory, even) to always check whether a variable is defined before attempting to access its value. set() Sets a new DataMapper record boundary.
-
start of the next page. if (boundaries.find("TOTAL", region.createRegion (10,10,215,279)).found) { boundaries.set(1); } Assume you want to set record boundaries whenever the text "TOTAL" appears in a specific region of the page of a PDF file, but the PDF file has already been padded with blank pages for duplexing purposes.
-
setVariable(varName, varValue) Sets variable varName to value varValue. varName String name of the variable of which the value is to be set. varValue Object; value to which the variable has to be set. Example This script examines a specific region and stores its contents in a variable in the boundaries. var addressRegion = region.createRegion(10, 30, 100, 50); var addressLines = boundaries.get(addressRegion); boundaries.
-
Method Description Script type File type "extract()" below Extracts the text value from a rectangular region. Extract, Condition, Repeat, and Action steps All "extractMeta ()" on page 393 Extracts the value of a metadata field. Extract, Condition, Repeat, and Action steps All "fieldExists ()" on page 393 Method that returns true if the specified metadata field, column or node exists.
-
Number that represents the distance, measured in characters, from the left edge of the page to the left edge of the rectangular region. The leftmost character is character 1. right Number that represents the distance, measured in characters, from the left edge of the page to the right edge of the rectangular region. verticalOffset Number that represents the current vertical position, measured in lines. regionHeight Number that represents the total height of the region, measured in lines.
-
Example 2: The script command data.extract(1,22,9,6,"
"); means that the left position of the extracted information is located at 1, the right position at 22, the offset position is 9 (since the first line number is 10) and the regionHeight is 6 (6 lines are selected). Finally, the "
" string is used for concatenation.
-
extract(xPath) Extracts the text value of the specified node in an XML file. xPath String that can be relative to the current location or absolute from the start of the record. Example The script command data.extract('./CUSTOMER/FirstName'); means that the extraction is made on the FirstName node under Customer.
-
extract(columnName, rowOffset) Extracts the text value from the specified column and row. columnName String that represents the column name. rowOffset Number that represents the row index (zero-based), relative to the current position. To extract the current row, specify 0 as the rowOffset. Use moveTo() to move the pointer in the source data file (see "moveTo()" on page 405). Example The script command data.extract('ID',0); means that the extraction is made on the ID column in the first row.
-
extract(left, right, verticalOffset, lineHeight, separator) Extracts the text value from a rectangular region in a PDF file. All coordinates are expressed in millimeters. left Double that represents the distance from the left edge of the page to the left edge of the rectangular region. right Double that represents the distance from the left edge of the page to the right edge of the rectangular region. verticalOffset Double that represents the distance from the current vertical position.
-
lineHeight Double that represents the total height of the region. separator String inserted between all lines returned from the region. If you don't want anything to be inserted between the lines, specify an empty string (""). Tip "
" is a very handy string to use as a separator. When the extracted data is inserted in a Designer template, it will be interpreted as a line break, because
is a line break in HTML and Designer templates are actually HTML files. Example The script command data.
-
extractMeta() Method that extracts the value of a metadata field on a certain level in a PDF/VT. This method always return a String. extractMeta(levelName String, propertyName String) levelName String, specifying the PDF/VT's level. Case sensitive. propertyName String, specifying the metadata field. fieldExists() Method of the data object that returns true if a certain metadata field, column or node exists. (See "data" on page 385.
-
fieldExists(levelName, propertyName) This method returns true if the given metadata field exists at the given level in a PDF file. levelName String that specifies the metadata field. propertyName String that specifies the level. fieldExists(fieldName) This method returns true if the specified column exists in the current record in a CSV file. fieldName String that represents a field name (column) in a CSV file.
-
Partial matches are not allowed. The entire string must be found between the two constraint parameters. The data.find() function only works on the current page. If the record contains several pages, you must create a loop that will perform a jump from one page to another to do a find() on each page. Note Calling this method does not move the current position to the location where the string was found.
-
Left=26,76, Top=149.77, Right=40,700001, Bottom=154.840302 These values represent the size of the rectangle that encloses the string in full, in millimeters relative to the upper left corner of the current page. findRegExp() Finds the first occurrence of a string that matches the given regular expression pattern, starting from the current position.
-
matching can be enabled by specifying the UNICODE_CASE flag (u) in conjunction with this flag. s: Enables dotall mode. In dotall mode, the expression . matches any character, including a line terminator. By default this expression does not match line terminators. L: Enables literal parsing of the pattern. When this flag is specified, then the input string that specifies the pattern is treated as a sequence of literal characters.
-
Examples data.findRegExp(/\d{3}-[A-Z]{3}/,"gi",50,100); or data.findRegExp("\\d{3}-[A-Z]{3}","gi",50,100);}} Both expressions would match the following strings: 001-ABC, 678-xYz. Note how in the second version, where the regular expression is specified as a string, some characters have to be escaped with an additional backslash, which is standard in JavaScript. db Object that allows to connect to a database. Methods The following table describes the methods of the db object.
-
user String that represents the user name for authentication. password String that represents the password for authentication. logger Global object that allows logging messages such as error, warning or informational messages. Methods The following table describes the methods of the logger object.
-
Property Description index The one-based index of this record, or zero if no data is available. tables The details table that belong to this record. You can access a specific table using a numeric index or the table name. Example See this How-to for an example of how the current record index, and/or the total number of records in the record set, can be displayed in a document: How to get the record index and count. region The region object defines a sub-section of the input data.
-
Property/method Description Return Type range Read-only object containing the physical coordinates of the region. Physical location of the region: x1 (left), y1 (top), x2 (right), y2 (bottom), expressed in characters for a text file or in millimeters for a PDF file. For a CSV file, it is the name of the column that defines the region. createRegion() Creates a region by setting the physical coordinates of the region object. A region that has the specified coordinates.
-
Example The following script attempts to match ((n,m)) or ((n)) against any of the strings in the specified region and if it does, a document boundary is set. var myRegion = region.createRegion(170,25,210,35); var regionStrings=boundaries.get(myRegion); if (regionStrings) { for (var i=0;i
-
l l For a PDF file, the range() method contains the physical coordinates of the region: x1 (left), y1 (top), x2 (right), y2 (bottom), expressed in millimeters. For a CSV file, the range contains the name of the column that defines the region. sourceRecord Returns a sourceRecord object containing custom properties specific to the current source record being processed. These are the custom properties defined in the Preprocessor step that have their Scope set to "Each record".
-
Method Description File type millimeters(e.g. PDF data). currentLoopCounter An integer value representing the current iteration of the containing loop. When loops are nested, you have access to the iteration for the current loop but not to any of the parent loops. Note: This variable is a counter so it starts at 1 as opposed to an index which usually starts at 0.
-
Example if(steps.currentPage > curPage) { steps.moveTo(0, steps.currentPosition+14); /* Moves the current position to 14 lines below the current position of the pointer in the data */ curPage++; } else if(curLine.startsWith("LOAD FACTOR")) { /* Extracts data to the curLine variable until the string "LOAD FACTOR" is encountered */ break; } else { lineArray.
-
Number that may be set to: l 0 or steps.MOVELINES l 1 or steps.MOVEDELIMITERS l 2: next line with content verticalPosition Number. What it represents depends on the value specified for scope. With the scope set to 0 or steps.MOVELINES, verticalPosition represents the index of the line to move to from the top of the record. With the scope set to 1 or steps.
-
verticalOffset Double. What it represents depends on the value specified for scope. With the scope set to 0 or steps.MOVEMEASURE, verticalOffset represents the number of millimeters to move the current position, relative to the top of the record (NOT the top of the current page). With the scope set to 1 or steps.MOVEPAGES, verticalOffsetrepresents the index of the target page, relative to the top of the record.
-
moveToNext(scope) Moves the current position in a text file or XML file to the next instance of scope. What scope represents depends on the emulation type: text or XML. Text scope Number that may be set to: l l l 0 or steps.MOVELINES: the current position is set to the next line. 1 or steps.MOVEDELIMITERS: the current position is set to the next delimiter (as defined in the Input Data settings). 2 (next line with content): the current position is set to the next line that contains any text.
-
Double that represents the right edge (in millimeters) of the text to find. moveToNext() Moves the current position in a CSV file to the next row, relative to the current position. Functions copyFile() Function that copies a file to the target file path, replacing it if it already exists. copyFile(source, target) source String that specifies the source file path and name. target String that specifies the target file path and name. Example This script copies the file test.txt from c:\Content into the c:\out
-
instance a process that retrieves certain values from Workflow’s Data Repository. Another possible use is to have a Postprocessor that writes the results of the extraction process to a file and immediately uploads that file to a Workflow process. The returned ScriptableHTTPRequest has a selection of the properties and methods of the standard JavaScript XMLHTTPRequest object (see https://developer.mozilla.org/enUS/docs/Web/API/XMLHttpRequest). Supported properties and methods are listed below.
-
password, pass empty strings: request.open ("GET",url,"",""); l send() l send(String requestBody) Sends an HTTP request and returns the HTTP status code. Blocked call. getResponseHeader(String header) Gets the ResponseHeader by name. getResponseHeaders() Returns the full response headers of the last HTTP request. getRequestBody() Gets the HTTP request body (for POST and PUT). setRequestHeader(String requestHeader, String value) Adds an additional HTTP request header.
-
getUsername() gets the username for basic HTTP authentication. setUsername(String userName) sets the username for basic HTTP authentication abort() Aborts the request. createTmpFile() Function that creates a file with a unique name in the temporary work folder and returns a file object. This file stores data temporarily in memory or in a buffer. It is used to prevent multiple input/output access to a physical file when writing.
-
} } finally{ // Close the reader reader.close(); } deleteFile(data.filename); tmpFile.move(data.filename); deleteFile() Function that is used to delete a file. deleteFile(filename) filename String that specifies the path and file name of the file to be deleted. Examples 1. Deleting a file in a local folder: deleteFile("c:\Content\test.txt"); 2. Deleting the sample data file used in the DataMapper: deleteFile(data.filename); execute() Function that calls an external program and waits for it to end.
-
newByteArray(size) Returns a new byte array of of the specified number of elements. size Integer that represents the number of elements in the new array. newCharArray() Function that returns a new Char array. newCharArray(size) Returns a new Char array of the specified number of elements. size Integer that represents the number of elements in the new array. newDoubleArray() Function that returns a new double array. newDoubleArray(size) Returns a new Double array of the specified number of elements.
-
newIntArray() Function that returns a new array of Integers. newIntArray(size) Returns a new Integer array of the specified number of elements. size Integer that represents the number of elements in the new array. newLongArray() Function that returns a new long array. newLongArray(size) Returns a new Long array of the specified number of elements. size Integer that represents the number of elements in the new array. newStringArray() Function that returns a new string array.
-
openBinaryWriter() Function that opens a file as a binary file for writing purposes. The function returns a DataOutputStream(see DataOutputStream). openBinaryWriter(filename, append) filename String that represents the name of the file to open. append Boolean parameter that specifies whether the file pointer should initially be positioned at the end of the existing file (append mode) or at the beginning of the file (overwrite mode).
-
fileIn.close(); fileOut.close(); deleteFile(data.filename); tmp.move(data.filename); tmp.close(); TextReader The TextReader object, returned by the openTextReader() function, allows to open, parse, read and close a text file. (See: "openTextReader()" on the previous page.) Methods The following table describes the methods of the TextReader object. Method Description close() Closes the stream and releases resources. open(inStream, inEncoding) Creates a reader from an input stream.
-
Method Description readLine() Reads and returns the next line, or null if the end of the stream has been reached. skip(offset) Skips the specified number of characters. Parameters: l offset: the number of characters to skip openTextWriter() This function opens a file as a text file for writing purposes. The function returns a "TextWriter" on the next page object. This must be closed at the end. openTextWriter(filename, encoding, append) filename String that represents the name of the file to open.
-
fileIn.close(); fileOut.close(); deleteFile(data.filename); tmp.move(data.filename); tmp.close(); TextWriter The TextWriter object, returned by the openTextWriter() function, allows to open a text file, write to it and close it. Methods The following table describes the methods of the TextWriter object. Method Description close() Close the stream. newLine() Creates a new line in the file. open(filename) Creates a new writer on a file to write at the beginning of the file.
-
Method Description l value: the string value to write Page 420
-
The Designer The Designer is a WYSIWYG (what you see is what you get) editor that lets you create templates for various output channels: Print, Email and Web. A template may contain designs for multiple output channels: a letter intended for print and an e-mail variant of the same message, for example. Content, like the body of the message or letter, can be shared across these contexts. Templates are personalized using scripts and variable data extracted via the DataMapper.
-
page 423. 2. Fill the template Add text, images and other elements to the template and style them. See "Content elements" on page 604 and "Styling and formatting" on page 718. 3. Personalize the content Personalize the content using variable data. See "Personalizing content" on page 762. 4. Generate output Adjust the settings, test the template and generate output: letters, emails, and/or web pages. See "Generating output" on page 1413.
-
l "Print" on page 446. This topic helps you design and fill sections in the Print context. l "Email" on page 488. This topics helps you design an email template. l "Web" on page 514. This topic helps you design a web page. "Sections" on page 442. Sections in one context are designed for the same output channel. "Content elements" on page 604. Elements make up the biggest part of the content of each design. "Snippets" on page 714.
-
There are Wizards for the three types of output channels, or contexts as they are called in the Designer: Print, Email and Web. See: l "Creating an Email template with a Wizard" on page 493 l "Creating a Print template with a Wizard" on page 449 l "Creating a Web template with a Wizard" on page 515 Tip The quickest way to create a Print template based on a PDF file is to right-click the PDF file in the Windows Explorer and select Enhance with Connect.
-
Warning A template created in an older version of the software can be opened in a newer version. However, opening and saving it in a newer version of the software will convert the template to the newest file format. The converted template can't be opened in older versions of the software. Opening a package file Templates can also be stored in a package file (see "Creating package files" on page 429). To open a package file, switch the file type to Package files (*.OL-package) in the Open File dialog.
-
Saving older templates Saving a template in a newer version of the software will convert the template to the newest file format. This makes it unreadable to older versions of the software. The warning message that is displayed in this case can be disabled. To re-enable this message (and all other warning dialogs), go to Window > Preferences > General, and click the Reset All Warning Dialogs button at the bottom.
-
Backup files have the same name as the original template with two underscores and a progressive number (without leading zeros) at the end: originalname__1.OL-template, originalname__2.OL-template, etc. Note The Auto Save function does not cause backup files to be created. File properties On the menu, select File > Properties to view and complement the file properties. See "File Properties dialog" on page 931. The file properties can also be used in scripts; see "template" on page 1383.
-
To create a package file, select File >Send to Workflowand choose File in the Destination box. For the other options, see "Sending files to Workflow" on the next page. The package file has the extension .OL-package and can be opened in the Designer (see "Opening a package file" on page 425). Exporting a template report A template report can be used for archiving purposes or to provide information about the template to people who do not have access to Connect.
-
To test a template first, select Context > Preflight. Preflights execute the template without actually producing output and it displays any issues once it's done (see also: "Testing scripts" on page 853). Sending files to Workflow Workflow can generate output from a template in automated processes. For this, the template has to be sent to Workflow. Alternatively you may create a Package file (see "Creating package files" below) and import that into Workflow.
-
Creating a Web template with a Wizard With the Designer you can design Web templates and output them through Workflow or as an attachment to an email when generating Email output. Capture On The Go templates are a special kind of Web templates; see "Capture OnTheGo template wizards" on page 553. A Web Template Wizard helps you create a Web page that looks good on virtually any browser, device and screen size.
-
l Jumbotron l Thank You If you don't know what template to choose, see "Web Template Wizards" on page 433 further down in this topic, where the characteristics of each kind of template are described. 3. Click Next and make adjustments to the settings. The wizard remembers the settings that were last used for a Foundation Web template. l Section: l l l Description: Enter the description of the page. This is the contents of a HTML tag.
-
l l l l A Web context with one web page template (also called a section) in it. The web page contains a Header, a Section and a Footer element with dummy text, and depending on the type of web page, a navigation bar, button and/or Form elements. Resources related to the Foundation framework (see "Web Template Wizards" on the next page): style sheets and JavaScript files. The style sheets can be found in the Stylesheets folder on the Resources pane.
-
Web Template Wizards Foundation With the exception of the most basic one, all Web Template Wizards in the Designer make use of the Zurb Foundation front-end framework. A front-end framework is a collection of HTML, CSS, and JavaScript files to build upon. Foundation is a responsive framework: it uses CSS media queries and a mobile-first approach, so that websites built upon Foundation look good and function well on multiple devices including desktop and laptop computers, tablets, and mobile phones.
-
A Capture OnTheGo Form is actually just a Web Form, that you could add without a wizard, but the COTG Template Wizards include the appropriate JavaScript files for the Capture OnTheGo app, and styles to create user-friendly, responsive forms. They are built upon the Foundation framework. Foundation With the exception of the most basic one, all Web Template Wizards in the Designer make use of the Zurb Foundation front-end framework.
-
2. Select a template. There are 8 types of Web Template Wizards: l l l l l l l l Blank. The Blank COTG Template has some basic design and the appropriate form, but no actual form or COTG elements. Bill of Lading. The Bill of Lading Template is a transactional template that includes a Dynamic Table with a checkmark on each line, along with Signature and Date COTG elements. Use this wizard as a way to quickly start any new Zurb Foundation based form for Capture OnTheGo. Event Registration.
-
Do the same for the background color of the navigation bar at the top and for the buttons on the Form. 4. Click Next to go to the next settings page if there is one. 5. Click Finish to create the template. The Wizard creates: l l l A Web context with one web page template (also called a section) in it. The web page contains an 'off-canvas' Div element, Header, a Section and a Footer element with dummy text, and depending on the type of web page, a navigation bar, button and/or Form elements.
-
Filling a COTG template Before inserting elements in a COTG Form, have the design ready; see "Designing a COTG Template" on page 549. In a Capture OnTheGo form, you can use special Capture OnTheGo Form elements, such as a Signature and a Barcode Scanner element. For a description of all COTG elements, see: "COTG Elements" on page 681. To learn how to use them, see "Using COTG Elements" on page 567.
-
Tip Click the Edges button on the toolbar t emporarily adds a frame to certain elements on the Design tab. These will not .Print or output. Tip If you have started creating your Capture OnTheGo template using a COTG Template Wizard, you can find ready-made elements in the Snippets folder on the Resources pane. Resources This page clarifies the difference between Internal, External and Web resources that may be used in a template, and explains how to refer to them in HTML and in scripts.
-
When refering to them, normally you would simply use the path directly with the file name. The structure within those folders is maintained, so if you create a "signatures" folder within the "Images" folder, you need to use that structure, for example in HTML:
. In scripts, you can refer to them in the same way, for example: results.loadhtml("snippets/en/navbar.
-
Web resources Web resources are simply accessed using a full URL. This URL needs to be publicly accessible: if you type in that URL in a browser on the server, it needs to be visible. Authentication is possible only through URL Parameters (http://www.example.com/data.json?user=username&password=password) or through HTTP Basic Auth (http://username:password@www.example.com/data.json).
-
with an Email Template Wizard; see "Creating an Email template with a Wizard" on page 493. Outputting and combining contexts All contexts can be present in any template and they can all be used to output documents; see "Generating Email output" on page 1443, "Generating Print output" on page 1415 and "Generating Web output" on page 1453. They can even be combined in output. If present in the same template, a Print context and a Web context can be attached to an Email context.
-
Warning If you don't have a backup of the template, the only way to recover a deleted section, is to click Undo on the Edit menu, until the deleted section is restored. After closing and reopening the template it is no longer possible to restore the deleted context this way. In the Saving Preferences you can set whether a backup file should be created when you save the template; see "Save preferences" on page 840. Sections Sections are parts of one of the contexts in a template: Print, Emailor Web.
-
Editing a section To open a section, expand the Contexts folder on the Resources pane, expand the respective context (Print, Emailor Web) and double-click a section to open it. Each section can contain text, images and many other elements (see "Content elements" on page 604), including variable data and other dynamic elements (see "Personalizing content" on page 762). To preview a section, open the Preview tab in the Workspace (see "Workspace" on page 1045). Copying a section To copy a section: 1.
-
Tip The easiest way to copy a section to another template, is to use the Import Resources dialog in the other template. See: "Import Resources dialog" on page 937. Deleting a section To delete a section: l On the Resources pane, expand the Contexts folder, expand the folder of the respective context, right-click the name of the section, and then click Delete. Warning No backup files are maintained in the template.
-
Applying a style sheet to a section In order for a style sheet to be applied to a specific section, it needs to be included in that section. There are two ways to do this. Drag & drop a style sheet 1. Click and hold the mouse button on the style sheet on the Resources pane. 2. Move the mouse cursor within the Resources pane to the section to which the style sheet should be applied. 3. Release the mouse button. Using the Includes dialog 1. On the Resources pane, right-click the section, then click Includes.
-
Arranging sections Changing the order of the sections in a context can have an effect on how they are outputted; see: "Print sections" on page 459, "Email templates" on page 499 and "Web pages" on page 521. To rearrange sections in a context: l On the Resources pane, expand the Contexts folder, expand the folder of the respective context, and then drag and drop sections to change the order they are in. Alternatively, right-click a section and click Arrange.
-
l PCL l PDF l PostScript (including the PPML, VIPP and VPS variants) With the Designer you can create one or more Print templates and merge the template with a data set to generate personal letters, invoices, policies, or any other type of letter you can think of. The Print context is the folder in the Designer that can contain one or more Print sections. Print templates (also called Print sections), are part of the Print context.
-
See "Pages" on page 469 for an overview of settings and elements that are specific for pages. Headers, footers, tear-offs and repeated elements (Master page) In Print sections, there are often elements that need to be repeated across pages, like headers, footers and logos. In addition, some elements should appear on each first page, or only on pages in between the first and the last page, or only on the last page.
-
Copy Fit Copy Fit is a feature to automatically adjust the font size of text to make it fit the available space. It could be used for the name of a person on a greeting card, for instance, or for the name of a product on a shelf talker. This feature is only available with Box and Div elements in Print sections. For more information about this feature see "Copy Fit" on page 735. Creating a Print template with a Wizard A Print template may consist of various parts, such as a covering letter and a policy.
-
Tip Use the Outline pane at the left to see which elements are present in the template and to select an element. Use the Attributes pane at the right to see the current element's ID, class and some other properties. Use the Styles pane next to the Attributes pane to see which styles are applied to the currently selected element. Basic Print template wizards There are two 'basic' Print Template wizards: one for a formal letter, and one for a postcard.
-
See "Print context" on page 454 and "Print sections" on page 459 for more information about Print templates. Formal letter The Formal Letter Wizard first lets you select the page settings, see "Page settings: size, margins and bleed" on page 471. These settings are fairly self-explanatory, except perhaps these: l l l l Duplex means double-sided printing. The margins define where your text flow will go. The actual printable space on a page depends on your printer.
-
expand the Contexts folder on the Resources pane; expand the Print folder and rightclick "Section 1"; then select Sheet Configuration.) See "Media" on page 481. l Selectors for variable data, for example: @Recipient@. You will want to replace these by the names of fields in your data. See "Variable Data" on page 777. The Wizard opens the Print section. You can add text and other elements; see "Content elements" on page 604. The formal letter template already has an address on it.
-
location should be accessible from the machine on which the template's output is produced. External images are updated (retrieved) at the time the output is generated. After clicking Next, you can change the settings for the page. The initial page size and bleed area are taken from the selected PDF. When you click Finish, the Wizard creates: l l l A Print context with one section in it; see "Print context" on the facing page and "Print sections" on page 459.
-
l Choose the desired type of business document from the General drop-down. l Select a color for the colored parts of the document; see "Color Picker" on page 926. l Enter your contact details. l l Click the Browse button to select a logo, or select to use a placeholder logo or no logo at all. Select a PDF file with the letterhead stationery. Also see "Media" on page 481. Tip Nice to know: your info and preferences are saved and will be reused the next time you create an ERP template.
-
Print templates (also called Print sections), are part of the Print context. They are meant to be printed directly to a printer or a printer stream/spool file, or to a PDF file (see "Generating Print output" on page 1415). The Print context can also be added to Email output as a PDF attachment; see "Generating Email output" on page 1443. When generating output from the Print context, each of the Print sections is added to the output document, one after the other in sequence, for each record.
-
In Print sections, there are often elements that need to be repeated across pages, like headers, footers and logos. In addition, some elements should appear on each first page, or only on pages in between the first and the last page, or only on the last page. Examples are a different header on the first page, and a tear-off slip that should show up on the last page. This is what Master Pages are used for. Master Pages can only be used in the Print context. See "Master Pages" on page 478.
-
Printing on both sides To print a Print section on both sides of the paper, that Print section needs to have the Duplex printing option to be enabled; see "Enabling double-sided printing (Duplex, Mixplex)" on page 467. This setting can not be changed in a Job Creation Preset or an Output Creation Preset. Note Your printer must support duplex for this option to work.
-
Setting the bleed The bleed is the printable space around a page. It can be used on some printers to ensure that no unprinted edges occur in the final trimmed document. The bleed is one of the settings for a section. See "Page settings: size, margins and bleed" on page 471. Overprint and black overprint Normally, when two colors overlap in Print output, the underlying color is not printed.
-
1. Right-click the Print context in the Resources pane and select Color Output. 2. Enable the Keep RGB black in output option. In Connect versions prior to 2018.2, RGB black was not automatically converted to CMYK black. Therefore, this option is by default enabled in templates made with an earlier version. In new templates, this option is disabled by default. Print sections Print templates (also called Print sections), are part of the Print context.
-
See "Master Pages" on page 478 for an explanation of how to fill them and how to apply them to different pages. Using stationery (Media) When the output of a Print context is meant to be printed on paper that already has graphical and text elements on it (called stationery, or preprinted sheets), you can add a copy of this media, in the form of a PDF file, to the Media folder. Media can be applied to pages in a Print section, to make them appear as a background to those pages.
-
to be printed out on paper. When a Print template is created (see "Creating a Print template with a Wizard" on page 449 and "Print context" on page 454), only one Print section is added to it, but you can add as many print sections as you need. To add a section to a context: l On the Resources pane, expand the Contexts folder, right-click the Print context , and then click New section. Note that the new section automatically gets the same properties as the first section.
-
Tip If you need a whole Print section to be visible in the output only under certain conditions, consider using the Conditional Print Section script wizard; see "Conditional Print sections" on page 790. You can use the Conditional Content script wizard to hide parts of the content of a section; see "Showing content conditionally" on page 787. Importing a Print section To import a section from another template, click File > Import Resources... in the menu. See: "Import Resources dialog" on page 937.
-
output in the order in which they appear on the Resources pane, so changing the order of the sections in the Print context changes the order in which they are outputted to the final document. To rearrange sections in a context: l l On the Resources pane, expand the Print context and drag and drop sections to change the order they are in. Alternatively, on the Resources pane, right-click a section in the Print context and click Arrange.
-
gives it less weight. In case of conflicting rules, style sheets read later will override previous ones. Note Style sheets are applied in the order in which they are included in a section. The styles in each following style sheet add up to the styles found in previously read style sheets. When style sheets have a conflicting rule for the same element, class or ID, the last style sheet ‘wins’ and overrides the rule found in the previous style sheet. Note Style sheets that are linked to (i.e.
-
this option you don't need to make any other settings; click OK to close the dialog. 3. For a PDF resource, you have to specify the path. Clicking the Select Image button opens the Select Image dialog (see "Select Image dialog" on page 989). 4. l Click Resources, Disk or Url, depending on where the image is located. l l l Resources lists the images that are present in the Images folder on the Resources pane.
-
generate output, and that their location should be accessible from the machine on which the template's output is produced. External images are updated (retrieved) at the time the output is generated. 5. Select the PDF's position: l Fit to page stretches the PDF to fit the page size. l Centered centers the PDF on the page, vertically and horizontally. l Absolute places the PDF at a specific location on the page.
-
Dynamic backgrounds To make the background change based on the value of a data field, you may use the Dynamic Background Script Wizard; see "Dynamic Print section backgrounds" on page 812. Alternatively you could write your own Control Script to set the background; see "Control Script: Setting a Print section's background" on page 887. The settings in a script take precedence over the settings made in the Print Section Properties dialog.
-
Note Your printer must support Duplex for this option to work. To enable Duplex or Mixplex printing: 1. On the Resources pane, expand the Print context, right-click the print section and click Sheet configuration. 2. Check Duplex to enable content to be printed on the back of each sheet. 3. When Duplex printing is enabled, further options become available. l Check Omit empty back side for Last or Single sheet to reset a page to Simplex if it has an empty back side.
-
Scripts" on page 879 and "Control Script API" on page 1355). This is especially useful when you need identical sections with different settings. The consequences of empty back sides for printing and page numbering In a Duplex job, the last page of a section may be empty since each new section starts on a new sheet. You may wonder what this means for the number of 'print clicks' and for the page numbering. Note that an empty page is defined as a page that has no content and no Master Page.
-
The minimum number of pages can be set via the Print section properties; see "Print section properties" on page 983. Although generally the same content elements can be used in all three contexts (see "Content elements" on page 604), the specific characteristics of pages make it possible to use special elements, such as page numbers; see "Page numbers " on page 472.
-
Page settings: size, margins and bleed On paper, whether it is real or virtual, content is naturally limited by the page size and margins. These, as well as the bleed, are set per Print section, as follows: l On the Resources pane, right-click a section in the Print context and click Properties. For the page size, click the drop-down to select a page size from a list of common paper sizes. Changing the width or height automatically sets the page size to Custom. Margins define where your text flow will go.
-
2. Insert the promotional image or snippet in the content. Note l l Only a top-level element (for example, a paragraph that is not inside a table or div) can function as a whitespace element. Do not place the promotional image or snippet inside an absolute positioned box. Whitespacing only works for elements that are part of the text flow, not for absolute-positioned boxes. 3.
-
in the Sheet Configuration dialog, see "Applying a Master Page to a page in a Print section" on page 480) but no contents, is not included in the Content page count. l l l Content page count: This is the total number of pages in the current document that have contents, supplied by the Print section. A page that has a Master Page but no contents, is not included in the Content page count. Sheet number: The current sheet number in the document.
-
Configuring page numbers By default the page numbers are Arabic numerals (1, 2, 3, etc.) without leading zeros nor prefix, and page numbering starts with page 1 for each section. But this can be changed. To do that: 1. On the Resources pane, right-click a section in the Print context and click Numbering. 2. Uncheck Restart Numbering if you want the page numbers to get consecutive page numbers, instead of restarting the page numbering with this section.
-
Note Widows and orphans are ignored if the page-break-inside property of the paragraph is set to avoid; see "Preventing a page break" on page 477. In the entire Print context To prevent widows and orphans in the entire Print context: 1. On the menu, select Edit > Stylesheets. 2. Select the Print context. 3. Click New (or, when there are already CSS rules for paragraphs, click the selector p and click Edit). 4. Click Format. 5.
-
In tables The CSS properties widows and orphans can be used in tables to prevent a number of rows from being separated from the rest of the table. Dynamic Tables are automatically divided over several pages when needed. A Standard Table doesn't flow over multiple pages by default. Splitting a Standard Table over multiple pages requires setting the Connect-specific data-breakable attribute on all of its rows.
-
3. In the Breaks group, set the before or after property. l l Before: Sets whether a page break should occur before the element. This is equivalent to the page-break-before property in CSS; see CSS page-break-before property for an explanation of the available options. After: Sets whether a page break should occur after the element. Equivalent to the page-break-after property in CSS; see CSS page-break-after property for an explanation of the available options.
-
Master Pages In Print sections, there are often elements that need to be repeated across pages, like headers, footers and logos. In addition, some elements should appear only on specific pages, such as only the first page, or the last page, or only on pages in-between. Examples are a different header on the first page, and a tear-off slip that shows up on the last page. This is what Master Pages are used for. Master Pages can only be used in the Print context (see "Print context" on page 454).
-
applied to different pages; see "Applying a Master Page to a page in a Print section" on the facing page. Importing a Master Page To import one or more Master Pages from another template, click File > Import Resources... in the menu. See: "Import Resources dialog" on page 937. Editing a Master Page Master Pages are edited just like sections, in the workspace. To open a Master Page, expand the Master pages folder on the Resources pane, and double-click the Master Page to open it.
-
2. Next, define the margins for the header and footer. The margins for a header and footer are set in the Master Page properties. This does not change the content placement within the Master Page itself; in Master Pages, elements can go everywhere on the page. Instead, the header and footer of the Master Page limit the text flow on pages in the Print sections to which this Master Page is applied.
-
consequently, check Omit Master Page Back in case of an empty back page to omit the specified Master Page on the last backside of a section if that page is empty. That page will then also be skipped from the page count unless the page numbers continue on the next section (see "Configuring page numbers" on page 474).
-
Per Media, a front and back can be specified and you can specify on what kind of paper the output is meant to be printed on. This includes paper weight, quality, coating and finishing; see "Setting Media properties" below. Adding Media To add a Media, right-click the Media folder on the Resources pane and select New Media. The new Media is of course empty. You can specify two PDF files for the Media: one for the front, and, optionally, another for the back.
-
2. Now you can change the name and page size of the Media. Note that it isn't possible to change the page size once the Media is applied to a section. Media can only be applied to sections that have the same size. 3. On the Virtual Stationery tab, you can click the Select Image button to select a PDF image file. Note Encrypted PDF files are not supported in PDF pass-through mode. See "PDF Options" on page 1163. l Click Resources, Disk or Url, depending on where the image is located.
-
they are used internally. Therefore, URLs that rely on one of these parameters cannot be used. l With an external image, you can check the option Save with template. If this option is checked, the file will be inserted in the Images folder on the Resources pane at the top left. If it isn't saved with the template, the image remains external.
-
1. On the Resources pane, expand the Contexts folder, expand the Media folder, and right-click the Media. Click Characteristics. 2. Specify the paper's characteristics: l l l l l l l Media Type: The type of paper, such as Plain, Continuous, Envelope, Labels, Stationery, etc. Weight: The intended weight of the media in grammage (g/m2). Front Coating: The pre-process coating applied to the front surface of the media, such as Glossy, High Gloss, Matte, Satin, etc.
-
1. On the Resources pane, expand the Print context; right-click the Print section, and click Sheet configuration. 2. Optionally, check Duplex to enable content to be printed on the back of each sheet. Your printer must support duplex for this option to work. If Duplex is enabled, you can also check Tumble to duplex pages as in a calendar, and Facing pages to have the margins of the section switch alternately, so that pages are printed as if in a magazine or book. 3.
-
2. Decide which pages should have dynamically switching media: every first page in the Print section, every last page, one of the pages in between (a 'middle page'), or a single page. (Uncheck the option Same for all positions, to see all page positions.) 3. In the area for the respective sheet position, click the Edit script button next to Media. The Script Wizard appears with a standard script: results.
-
Note l l Any Virtual Stationery settings made for the Media also influence how the Media is displayed in each section (see "Setting Media properties" on page 482). Section backgrounds are rotated separately (see "Using a PDF file or other image as background" on page 464). If in the Media properties, the Virtual Stationery position is set to Absolute, any offset given by the Top and Left values will be applied after rotation.
-
HTML email that displays properly on a variety of devices and screen sizes is challenging. Building an email is not like building for the web. While web browsers comply with standards (to a significant extent), email clients do not. Different email clients interpret the same HTML and CSS styles in totally different ways.
-
Designing an Email template With the Designer you can design Email templates. It is strongly recommended to start creating an Email template with an Email Template Wizard, because it is challenging to design HTML email that looks good on all email clients, devices and screen sizes that customers use when they are reading their email.
-
Email templates: Slate and others The most obvious solution offered in the Designer is to use one of the templates provided with the Designer; see "Creating an Email template with a Wizard" on page 493. The layout of these templates has been tested and proven to look good in any email client, on any device and screen size. The Tables in these templates are nested (put inside another table) and they have no visible borders, so readers won't notice them.
-
All standard abbreviations can be found in Emmet's documentation: Abbreviations. To learn more about Emmet, please see their website: Emmet.io and the Emmet.io documentation: http://docs.emmet.io/. Preferences To change the way Emmet works in the Designer, select Window > Preferences, and in the Preferences dialog, select Emmet; see "Emmet preferences" on page 830.
-
Do not capture your email in one big image Most e-mail clients do not automatically download images, so do not capture your email in one big image. The recipient initially sees a blank message and probably deletes it right away. Do not resize images in your email Many mail clients do not support image resizing and will show the image in its original dimensions. Resize the images before you link to or embed them.
-
1. In the Welcome screen that appears after startup: l l Choose Browse Template Wizards. Scroll down until you see the Email Template Wizards. There are three types of Email Template Wizards: l Basic Email templates l Banded Email templates l Slate: Responsive Email templates by Litmus. Or choose Create a New Template and select the Email template. This starts the Basic Action Email wizard. Alternatively, on the File menu, click New, and: l l Select Email Template.
-
called "email-to". After loading dataor a data mapping configuration, you can change the script so that it uses the actual field in your data that holds the customer's email address. See "Email header settings" on page 503 l A style sheet, named context_htmlemail_styles.css, and another style sheet depending on which Template Wizard was used. The style sheets can be found in the Stylesheets folder on the Resources pane.
-
Slate: Responsive Email Templates by Litmus Scroll past the Web Template Wizards to see the Slate: Responsive Email templates, created by Litmus (see https://litmus.com/resources/free-responsive-email-templates). More than 50% of emails are opened on mobile. These five responsive HTML email templates are optimized for small screens and they look great in any inbox. They’ve been tested in Litmus and are completely bulletproof.
-
l l l The text for the header. The header is the colored part at the top. The text can be edited later. The color of the header and the color of the button. Click the small colored square, right next to the field that holds the default color value, to open the Color dialog and pick a color (see "Color Picker" on page 926). The color can be changed later; see "Colors" on page 752. The web address where the recipient of the email will be taken after clicking the button in the email.
-
The Wizard opens the Email section, so that you can fill it with text and other elements; see "Content elements" on page 604 and "Email templates" on the next page. Sending email When the template is ready, you can generate Email output; See "Generating Email output" on page 1443. To test a template, you can send a test email first. This allows you to override the recipient address.
-
Compressing PDF attachments For PDF attachments, generated from the Print context, you can set the Print Context Image Compression to determine the quality of the files, and with that, the size of the files. To set the Print Context Image Compression: 1. On the Resources pane, expand the Contexts folder; then right-click the Email context and select PDF Attachments. Alternatively, select Context > PDF Attachments on the main menu. This option is only available when editing an Email section in the Workspace.
-
it is advisable to position elements using Tables and to put text in table cells (see "Designing an Email template" on page 490). Email templates are personalized just like any other template; see "Variable Data" on page 777. The subject, recipients (To, CC and BCC), sender and reply-to address are specified with Email Script Wizards; see "Email header settings" on page 503. An Email context can contain multiple templates.
-
Importing an Email template To import an Email section from another template, click File > Import Resources... in the menu. See: "Import Resources dialog" on page 937. Remember also to add or import any related source files, such as images. Note that when the imported Email section replaces an Email section in your template, the PDF attachments settings are imported as well. (See: "Compressing PDF attachments" on page 499.
-
Tip Before you can style an element, you have to select it. In an Email context it can be difficult to select an element by clicking on it. Use the breadcrumbs at the top and the Outline pane at the left, to select an element. See "Selecting an element" on page 608. In order for a style sheet to be applied to a specific section, it needs to be included in that section. There are two ways to do this. Drag & drop a style sheet 1. Click and hold the mouse button on the style sheet on the Resources pane. 2.
-
Note Style sheets that are linked to (i.e. included in) a section show a chain icon in the Resources pane (see "Resources pane" on page 1034). Setting a default Email template for output An Email context can contain multiple templates. When generating output from the Email context, however, only one of the Email templates can be merged with each record.
-
Email Fields The subject, the recipients (To, Cc and Bcc), the sender and the Reply to address can be entered in the Email Fields at the top of the workspace. If the fields are not visible, click the words 'Email Fields' (or the small plus before them) to expand the Email Fields area. To use a variable email address in any of the fields, simply drag and drop a data field into the email field. The specified subject and addresses will be visible when viewing the email in the workspace in Preview mode.
-
Other header fields At some point you may need to define a header field that isn't available in the Preferences or in the Email Fields. This can be done in a Control Script. For a few examples of such scripts, see "Adding custom ESP handling instructions" on page 1450. To get started with Control Scripts, refer to "Control Scripts" on page 879. Email SMTP settings Simple Mail Transfer Protocol (SMTP) is the standard protocol for sending emails across the Internet.
-
be maintained in the new version. In the Send Test Email dialog and Send Email dialog (see "Send (Test) Email" on page 986) you will be able to choose one of the presets and adjust the settings to your needs. Subject To specify a subject for an email template: 1. Open the email section and expand the Email Fields by clicking Email Fields at the top of the section. 2. Type the subject in the Subject field.
-
Writing a custom Subject script The default script replaces all @field@ placeholders in the subject line with field values. This script can be modified, for example to create a subject that depends on the value of a data field. Open the Script Wizard (see "The Email Script Wizard" on page 504), click the Expand button and modify the script. If you don't know how to write a script, see "Writing your own scripts" on page 843 first.
-
This name and email address will appear as the default in the Send Email and Send Test Email dialogs (see "Send (Test) Email" on page 986). The default can be overwritten by typing an email address directly in the From field (as long as no script is present for this field). Using the Script Wizard you can create a dynamic From address; see "The Email Script Wizard" on page 504. It is also possible to drag and drop one data field into the From field directly.
-
Meta information Meta information in an email header is not visible to the receiver, but might have an effect on the representation of the email in the e-mail client. The information may also be used by an Email Service Provider (see "Using an ESP with PlanetPress Connect" on page 1448). To add custom meta information to an email header: 1. Right-click the email section on the Resources pane and select Properties.... 2.
-
Password types PDF allows for two types of passwords to be set on a secured PDF file: a user password and owner password. The user password allows a limited access to the file (e.g. printing or copying text from the PDF is not allowed). The owner password allows normal access to the file. The Email PDF password script sets both the user and owner password to the same value, so that when the recipient provides the password, he can manipulate the file without limitations.
-
Compression options for PDF attachments can be specified in the Email Context Properties dialog; see "Compressing PDF attachments" on page 499. When adding the Web context to an email, only the default Web section is generated and added to the email as an HTML file that is named after the email subject.
-
Dynamic attachments: creating file names based on data fields The new Dynamic Attachment wizard lets you concatenate this value with the base location and/or file extension to construct the path. Dynamic Attachment scripts are created via the New option on the toolbar of the Scripts panel. The Dynamic Attachment Script Wizard lets you add a different attachment for each email recipient. It composes one file name (including the path) based on the value of one or more data fields. 1.
-
Note For attachment names, it is recommended to use only US-ASCII characters. Other characters may not be supported by all email servers and clients. Note Certain characters are invalid in a URL (for example, '$', '%', and '&') and must be percent-encoded. The same applies to a file path, since that actually is a URL that starts with the file protocol. Note that even a space character is invalid in a URL.
-
Dynamic attachment scripts add a element to the
of an Email section. The title attribute of that element specifies the attachment name that will show up in the email. Take a look at the last line of the script: results.append(query("").attr("title", result.split('/').pop()).attr("href", result)); To give the attachment another name, you have to replace the bold part of the code by that new name. For example: results.append(query("").attr("title", "Invoice.
-
or COTG Web Template Wizard, the Foundation framework is added to the template, to guarantee just that; see "Creating a Web template with a Wizard" below and "Capture OnTheGo template wizards" on page 553. Tip You can use the Responsive Design View drop-down at the top of the workspace to see how your web page looks and behaves with different screen sizes.
-
and function well on multiple devices including desktop and laptop computers, tablets, and mobile phones. Foundation is tested across many browsers and devices, and works back as far as IE9 and Android 2. See http://foundation.zurb.com/learn/about.html. For more information about the use of Foundation in the Designer, see "Using Foundation" on page 557.
-
l l l l Set width to Grid: Check this option to limit the width of the top bar contents to the Foundation Grid, instead of using the full width of the page. Stick to the top of the browser window: Check to lock the top menu bar to the top of the page, even if the page has scroll bars. This means the menu bar will always be visible in the browser.
-
The Wizard opens the Web section, so that you can fill it with text and other elements; see "Content elements" on page 604, "Web Context" on the next page and "Web pages" on page 521. Web pages can be personalized just like any other type of template; see "Variable Data" on page 777 and "Personalizing content" on page 762. Tip Use the Outline pane at the left to see which elements are present in the template and to select an element.
-
important text and its "call to action" button invites a visitor to click on to more information or an order form. Contact Us The Contact Us template is a contact form that can be used on a website to receive user feedback or requests. It's great to use in conjunction with the Thank You template, which can recap the form information and thank the user for feedback. Thank You The Thank You template displays a thank you message with some text and media links.
-
l A style sheet, named context_web_styles.css, is added to the template. If a Template Wizard was used to create the template, Foundation style sheets are added as well. Style sheets are located in the folder Stylesheets on the Resources pane. These style sheets are meant to be used for styles that are only applied to elements in the Web context; see "Styling and formatting" on page 718.
-
Web pages Web pages (also called Web sections) are part of the Web context (see "Web Context" on page 519) in a template. The Web context outputs one HTML web page. In addition to the HTML text it contains either the resources or references to the resources necessary to display it. JavaScript files are added to the
in the generated HTML file. JavaScript toolboxes like jQuery and its plugins, or MooTools, are useful when you want to implement special features in the web page.
-
Tip For an example of how to serve different web pages using snippets, see the following how-to: Creating a multi-page Web template. If you would like to start with a template that is identical to the one you already have, consider copying it (see "Copying a section" on page 443). To add a blank section to the Web context: l On the Resources pane, expand the Contexts folder, right-click the Web folder, and then click New Web page.
-
Filling a Web page Many of the content elements that are available for all three contexts are particularly suitable for web pages; see "Content elements" on page 604. Do not use Positioned Boxes and Tables to position elements, however; use Inline Boxes instead. Forms and Form elements are only available in a Web context; see "Forms" on page 688 and "Form Elements" on page 694. Using variable data on a Web page Web templates are personalized just like any other template; see "Variable Data" on page 777.
-
1. Click and hold the mouse button on the style sheet on the Resources pane. 2. Move the mouse cursor within the Resources pane to the section to which the style sheet should be applied. 3. Release the mouse button. Using the Includes dialog 1. On the Resources pane, right-click the section, then click Includes. 2. From the File types dropdown, select Stylesheets. 3. Choose which CSS files should be applied to this section. The available files are listed at the left.
-
Setting a default Web page for output When generating output from the Web context, only one of the Web templates can be merged with each record. To select the Web section that will be output by default: l On the Resources pane, expand the Web context, right-click a section and click Set as Default. Tip Use a Control Script to dynamically select a Web section for output depending on the value of a data field. See "Control Scripts" on page 879.
-
1. On the Resources pane, expand the Web context, right-click the section and click Properties. 2. Enter the Page Title. The contents of this field will go in the
HTML tag. (Name is the name of the section in the Web context; this has no effect on output.) 3. Add a Shortcut Icon by entering the path to the favicon.ico file, for instance images/favicon.ico. Tip If a valid favicon image is dragged to the Web section, it will automatically be set as a shortcut icon. 4.
-
Example The following script adds a element to the head of a web page. results.append(""); Forms Web templates can contain Forms. Capture OnTheGo templates always contain a Form. Tip To create a Capture OnTheGo template, preferably use a Template Wizard (see "Capture OnTheGo template wizards" on page 553).
-
Workflow's default port number; 'action' should be replaced by the HTTP action of that particular HTTP Server Input task).The method of a Capture OnTheGo form should be POST to ensure that it doesn't hit a data limit when submitting the form. The GET method adds the data to the URL, and the length of a URL is limited to 2048 characters. Especially forms containing one or more Camera inputs may produce a voluminous data stream that doesn't fit in the URL.
-
multiple different fields. Add the Fieldset after inserting the Form; see "Adding elements to a Form" on page 532. 9. Double-click each field in the Fields list and change its settings. For an explanation of the settings, see "Adding elements to a Form" on page 532. 10. The order of the elements in the list under Fields determines in which order the elements will be added to the Form. Use the Move Up and Move Down buttons to change the order of the elements in the list. 11.
-
page 681). Changing a Form's properties and validation method Once a Form has been added, you can of course edit its HTML code directly in the Source view of the workspace. Apart from that, there are a number of dialogs to change a Form's properties and validation settings. Changing a Form's properties 1. Select the form (see "Selecting an element" on page 608). 2. On the Attributes pane you can change: l l l l The ID and/or class.
-
requirements per field and a different message for each field to display to the user if the input is not valid. This method ensures a more consistent validation, as it is browser independent. The necessary JQuery files will be added to the JavaScript folder on the Resources pane when this option is chosen. To change a Form's validation method: 1. Right-click on the Form element and choose Validation settings. 2. Choose a validation type (see above). 3.
-
the Form's validation method to jQuery Validation, as described above. When you click OK, the new version of the web-form-validation.js file will be added. Submitting a Form When a form is submitted, by clicking or touching the Submit button, the name and value of form elements are sent to the address that is specified in the Form's action (see "Adding a Form" on page 527 or "Changing a Form's properties" on page 530). If the name attribute is omitted, the data of that input field will not be sent at all.
-
ID's and classes are also useful with regard to variable data (see "Personalizing content" on page 762) and styling (see "Styling templates with CSS files" on page 719). 2. Type a label, or choose No label under Style, to omit the label. (For Label elements there are no other options to be set.) 3. If applicable, choose a style for the label (for the label of a Checkbox, for example, you can't set a style). l l l l Wrap input with label places the input element inside the Label element.
-
l For a Button, you can set the button type: l l Submit: The button will validate the form data and if validation is successful, send the data to the provided URL (the action specified for the Form; see "Changing a Form's properties" on page 691). Reset: The button will reset the form to its original configuration, erasing any information entered and options provided. Note: This cannot be undone! 5.
-
Changing a form element Once an element has been added to a Form, it can easily be changed: simply select the element in the template, go to the the Attributes pane, and edit the element. An input element can even be changed to another type of input element by selecting the desired input type from the Type drop-down list.
-
Between the second pair of square brackets, define the key to which the value belongs. Consider the following HTML form inputs: PAGE 537
pparker@eu.objectiflune.com Peter Parker Objectif Lune 122 253 dent 361 341 dent This option makes it easier to select all elements on the same level in a data mapping configuration, and to convert the XML to a JSON object.
-
Tip The Capture OnTheGo (COTG) plugin automatically adds a hidden field for every unchecked checkbox on a Form when the Form is submitted. It does this for every Form; the template doesn't have to be a COTG template. (See: "Using the COTG plugin: cotg2.0.0.js" on page 579.) Using JavaScript JavaScript files, libraries and frameworks can be added to a template, primarily for use in Web pages and Capture OnTheGo Forms.
-
1. Add the file: l l l Right-click the JavaScript folder on the Resources pane, and click New JavaScript. Double-click it to open and edit it. Alternatively, drag and drop the JavaScript file from the Windows Explorer to the JavaScript folder on the Resources pane. Or import one or more JavaScript files from another template; see "Import Resources dialog" on page 937. 2. Make some settings for the file: right-click the file on the Resources pane and select Properties.
-
l l These resources are not served by your server, saving on space, bandwidth and processing. Using a popular CDN takes advantage of caching - a client having visited another website using that same CDN will have the file in cache and not re-download it, making for faster load times for the client. To add a remote JavaScript: 1. Right-click the JavaScript folder on the Resources pane, and click New Remote JavaScript. 2. Enter a name for the file as it appears in the JavaScript resources.
-
Tip After adding the remote file, you may right-click it and select Download Resource. This allows you to maintain a central file, from which you can quickly download a copy to your template without having to copy & paste. Note that a local copy of a remote resource is a snapshot; it is not automatically kept in sync with its remote content. You can download the remote resource again to overwrite the local copy with updated content.
-
Using JavaScript in other contexts Email clients do not support JavaScript. Therefore, Email contexts cannot include JavaScript resources. When a JavaScript file is included in a Print section, the Designer itself acts as the browser. When generating Print output, it runs the JavaScript after generating the main page flow contents and the pagination, but before any Master Pages are added.
-
Capture OnTheGo With the Designer you can create Capture OnTheGo templates. COTG templates are used to generate forms for the Capture OnTheGo mobile application. For more information about the application refer to these websites: Capture OnTheGo and Capture OnTheGo in the Resource Center.
-
Before starting to create a COTG Form, take some time to structure the design process and to get familiar with the principles of form design, as explained in the topic "Designing a COTG Template" on page 549. Reusable forms Capture OnTheGo forms can be single-use or reusable. This doesn't depend on the design (although, of course, this should be reflected in the design). What makes a form reusable is a setting in the Output to Capture OnTheGo plugin in Workflow; see Output to CaptureOnTheGo.
-
"COTG Elements" on page 681. To learn how to use them, see "Using COTG Elements" on page 567. Tip If you have started creating your Capture OnTheGo template using a COTG Template Wizard, you can find ready-made elements in the Snippets folder on the Resources pane. Foundation, the framework added by the COTG template wizards, comes with a series of features that can be very useful in COTG forms; see "Using Foundation" on page 557.
-
Using JavaScript COTG plugin Capture OnTheGo widgets do not function without the COTG plugin: cotg-2.0.0.js. This plugin also makes it possible to add COTG Elements dynamically, set defaults for COTG elements, react to events that occur when a user interacts with a COTG element, etc. For more information see: "Using the COTG plugin: cotg-2.0.0.js" on page 579.
-
Next, you can start building a Workflow configuration that receives and handles the submitted data. The configuration should start with a HTTP Server Input task (see Workflow Help: HTTP Server Input) of which the HTTP action is the one specified in the COTG Form's action. Using COTG data in a template When a user submits a COTG Form, a Workflow configuration may store the information in a database and/or push it into other Workflow processes, for example to send a letter or an email receipt.
-
2. Create a data mapping configuration Use the resulting XML file to create a data mapping configuration (see "Data mapping configurations" on page 195). 1. Choose File > New > Data mapping Wizards > From XML file. 2. Select the XML data file as its source and click Next. 3. Set the XML Elements option to /request/values. This will automatically add an extraction step for the submitted form fields. 4. Click Finish.
-
1. Click the Insert Inline Box icon on the toolbar. The Insert Inline Box dialog appears. 2. Enter an ID for the box (anything will do, as long as it helps you identify the box) and click OK. The box is added to the text flow and can be resized if needed. 3. Switch to the Source tab and replace the content of the box:
Div content goes here
by this text:
4. Switch back to the Design tab. You will see a small, empty rectangle inside at the top of the inline box.
-
company actually needs will prove to be well worth your time. Creating specifications up front prevents discussions, reduces rework and therefore saves time. 2. Listing the input fields that are needed, their type, and possible input constraints. Think of how the information should be visually grouped.
-
Tip If the COTG Form replaces a paper form, it can be tempting to stick to the original layout for the sake of recognizability. Don't fall into that trap. In the end, the users - customers and employees will be happier with a user-friendly form that adapts to different screen sizes and looks like it was designed for the web. Most design guidelines for web forms apply to COTG forms as well. Two key concepts are responsive design and usability.
-
Usability Usability defines the ease of use of a form. Is the layout intuitive? Are the form elements easy to tap on a mobile device? A visually consistent design allows the user to follow the flow while filling out the form. Below are some key usability aspects to keep in mind when designing forms. Provide clear labels. Many modern web sites show labels inside the actual form inputs while they are empty. This saves space on the form, but once the user has entered data the label is no longer visible.
-
Forms for offline use Capture OnTheGo forms can be used offline. This is the case even when the form relies on remotely stored source files like JavaScript files and style sheets, provided that the option Use cached Capture OnTheGo resource is checked when adding them to the form. Capture OnTheGo template wizards With the Designer you can create Capture OnTheGo (COTG) templates. COTG templates are used to generate forms for the Capture OnTheGo mobile application.
-
user-friendly as possible. See "Designing a COTG Template" on page 549. Creating a COTG template using a wizard To create a COTG template with a template wizard: 1. l l In the Welcome screen that appears after startup and when you click the Home icon at the top right, choose Browse Template Wizards. Scroll down until you see the Capture OnTheGo Starter Template Wizards. Alternatively, on the File menu, click New, expand the Template folder, and then expand the Capture OnTheGo Starter folder. 2.
-
3. Click Next and make adjustments to the settings. The wizard remembers the settings that were last used for a COTG template. l l l l Create Off-Canvas navigation menu: an Off-Canvas menu is a Foundation component that lets you navigate between level 4 headings (
) in the form. Check this option to add the menu automatically. Submit URL: enter the URL where the form data should be sent. The URL should be a server-side script that can accept COTG Form data.
-
The action of a Capture OnTheGo form should specify the Workflow HTTP Server Input task that receives and handles the submitted data. The action will look like this: http://127.0.0.1:8080/action (8080 is Workflow's default port number; 'action' should be replaced by the HTTP action of that particular HTTP Server Input task). The method of a Capture OnTheGo form should be POST to ensure that it doesn't hit a data limit when submitting the form.
-
Tip Use the Outline pane at the left to see which elements are present in the template and to select an element. Use the Attributes pane at the right to see the current element's ID, class and some other properties. Use the Styles pane next to the Attributes pane to see which styles are applied to the currently selected element. Tip Click the Edges button on the toolbar t emporarily adds a frame to certain elements on the Design tab. These will not .Print or output.
-
Capture OnTheGo and Jumbotron template wizards automatically add the Foundation files v. 5.5.1 to the resources of the template. In a future version of PlanetPress Connect, Foundation 6 will be included. If you'd rather start using the newest Foundation files right away, you have two options: l l Download the Foundation files (from http://foundation.zurb.com/sites/download.html/) and add them to the template manually. Use remote Foundation files from a CDN, such as https://cdnjs.
-
These classes can be combined, so that depending on the screen size, a Div can take more or less space in a row. Separate the class names with a space. Tip Start with the class for small screens. For example:
. Larger devices will inherit those styles (thanks to the mobile-first approach of Foundation's style sheet). Customize for larger screens as necessary.
-
To add Grid rows and columns quickly, you could also use the Grid snippets or Row snippets, found in the Snippets folder on the Resources pane after using a wizard to create a Foundation web page or a Capture OnTheGo template. For more information about Snippets, see "Snippets" on page 714. For more information about template wizards, see "Creating a Web template with a Wizard" on page 515 and "Capture OnTheGo template wizards" on page 553.
-
OnTheGo form elements. For more information about the application refer to these websites: Capture OnTheGo and Capture OnTheGo in the Resource Center. Capture OnTheGo (COTG) elements can only be added within a Form element in a Web context; see "COTG Forms" on page 543. For information about how to add and use COTG Elements, see "Using COTG Elements" on page 567.
-
l l l Take now: Opens the device's default Camera application to take a picture using the device's camera. Capture OnTheGo has no impact on the device's applications, so the features available (quality, orientation, filters) are dependent on the device itself. You can, however, set the format, quality and scaling for images that are submitted by the Camera element, as explained below.
-
and edit the Image properties: l Format: The image format can be PNG or JPG. l Quality: Set the compression in a percentage. l Scale Image: Check this option to enable image scaling. Then set the maximum width and height of images before they are sent to the server. Note that only the smallest of these is applied and the size ratio is always maintained. Time stamp A time stamp can be added to each picture taken.
-
Date and Formatted Date The Date element and the Formatted Date element display the current date on the device when the form is first opened. When the element is touched, a date selector appears so the user can modify this date. The Formatted Date element displays dates in a format that depends on the locale of the device on which the user is viewing the form. A Date Element displays dates in the ISO 8601 format: YYYY-MM-DD. When the form is submitted, the date data is sent as plain text.
-
Geolocation The Geolocation Element adds a button to read the device's current GPS coordinates and save them in a form field. When the button is pressed, the GPS coordinates are requested and saved. When the form is submitted, the Geolocation data is sent in plain text. High accuracy By default, devices attempt to retrieve a position using network-based methods.
-
Repository ID The Repository ID element retrieves the repository ID (read only) from the app based on the currently logged on COTG user. You could put the Repository ID in a hidden input, so that when the form is submitted, the Repository ID is submitted as well. This information can be used on the server side to take specific actions, such as sending properly branded emails. Signature The Signature Element adds a signature box to a COTG form.
-
form is available to many different users, to detect who submitted it. If desired the field can be hidden; it will still be submitted. Using COTG Elements Capture OnTheGo (COTG) elements are Web Form elements that are specially designed to be used in a Capture OnTheGo Form (see "Capture OnTheGo" on page 543). This topic explains how to add these elements to a Capture OnTheGo Form or and how to prepare them so that when the Form is submitted, they provide valid data that can be handled easily.
-
l l Use label as placeholder inserts the given label text in the placeholder attribute of the field. No style omits the label altogether. Note The first two label styles ensure that when the user clicks the label, the input element gets the focus. When you add a Capture OnTheGo (COTG) element to a template that you didn't start with a COTG template wizard, the Designer will automatically add the necessary JavaScript files: the jQuery library and the COTG library: cotg-2.0.0.js.
-
All COTG elements have a role attribute. This attribute is not supposed to be edited: without the correct role attribute, the element won't function. As noted, the name attribute is what identifies the element after submitting the form. Tip Use the Outline pane at the left to see which elements are present in the template and to select an element. Use the Attributes pane at the right to see the current element's ID, class and some other properties.
-
{"timeout":6000}">. Settings in the HTML override the default settings for that element. They are applied to the widget when the Form is created and cannot be changed afterwards. For a complete list of options see the Capture OnTheGo API: "Capture OnTheGo API" on page 592. Settings for a dynamically added element can be made in code; see "Dynamically adding COTG widgets" on page 582.
-
With the Use PHP arrays option enabled in Workflow, the above HTML results in the following XML: pparker@eu.objectiflune.
-
341 dent This option makes it easier to select all elements on the same level in a data mapping configuration, and to convert the XML to a JSON object. You can try out this feature with the COTG Time Sheet template, as explained in this how-to: Using The PHP Array Option. The COTG Fields Table element (see "Fields Table" on page 685) in that template has an Add button to add rows to a table, and groups data following this approach.
-
Previewing the form On a PC A Capture OnTheGo template can be previewed on a PC in two different ways. Note that Capture OnTheGo form elements will not be functional unless they are sent to a device. l l Within PlanetPress Connect Designer. You can open the Preview tab or the Live tab in the Workspace. This displays the output HTML along with any variable data being added.
-
1. Go to the Capture OnTheGo Repository Login: https://config-us.captureonthego.com/. 2. Login with your Repository ID and Password. 3. Go to the Users page. 4. Add a new user. The user name should be in the form of an email address. Next, make sure that the Capture OnTheGo mobile application is installed and that it is logged on as a known user of the Capture OnTheGo Repository. Now, with your Capture OnTheGo template open in the Connect Designer module, click on the Send COTG Test… button in the toolbar.
-
validation method" on page 692 and "How to make COTG elements required" on page 569). Get Job Data File on Submit It is possible to test a COTG Form in the Designer and get access to an XML file that contains the submitted data, without having a Workflow configuration to handle the data. This option requires that: l l Workflow has been installed on the local machine, and the Workflow HTTP/Soap Service has been started.
-
4. Save the XML file to disk. You can view it, create or update a data mapping configuration for it (see "Data mapping configurations" on page 195), and insert the data in a template, using the data mapping configuration (see "Personalizing content" on page 762). Note Checkboxes and Radio buttons that are unchecked will not be submitted to the job data. This is standard behavior in HTML.
-
Capture On The Go input dummy data values Input Dummy Value Signat ure Receives SVG signature data and the onscreen presentation of that data. Camer a A dummy foto is added, and a (SVG) annotation if that option is set for the widget. Note that the script doesn't look at the PNG/JPG or resolution options, the only option it considers is the annotation option.
-
Input Dummy Value widget Locale widget en-US * Note that the formatted date and time can be different from the values that the COTG app provides. In the COTG app the formatted date comes from the COTG API, and the formatted date and time normally depend on the locale/region settings on the mobile device. The ISO date and time should be the same as when using the COTG app.
-
Get submitted data via Workflow Eventually, when a user submits a Capture OnTheGo Form, the data are received by the Workflow HTTP Server Input task (see Workflow Help: HTTP Server Input) that has the same HTTP action as the one specified in the Form's action (see "COTG Forms" on page 543). The Workflow configuration should then handle the submitted data.
-
Form. If you are new to it, spend a few minutes on learning it - it's that easy. For more information, see: https://jquery.com/. and http://learn.jquery.com/. Adding the plugin When you create a template with a COTG Template Wizard (see "Capture OnTheGo template wizards" on page 553), the Designer automatically adds the jQuery library and the COTG library: cotg-2.0.0.js. This also happens when you add a Capture OnTheGo (COTG) element to a template that you didn't start with a COTG template wizard.
-
Example The following code sets the default timeout and accuracy for Geolocation objects. and the default maximum height and width for Camera widgets. $.fn.cotgGeolocation.defaults.timeout = 6000; // 6 secs $.fn.cotgGeolocation.defaults.enableHighAccuracy = true; $.fn.cotgPhotoWidget.defaults.width = 1024; $.fn.cotgPhotoWidget.defaults.height = 768; $.fn.cotgPhotoWidget.defaults.quality = 60; Reacting to, or triggering, widget events The new COTG plugin introduces custom events for COTG controls.
-
$('#date1').trigger("show-date-picker.cotg", new Date("2018 01")); }); }); Dynamically adding COTG widgets Capture OnTheGo (COTG) widgets can be added to a Form dynamically, via jQuery. For example: a new Camera element could be added when the user clicks an Add button. This topic explains how to implement this. It is assumed that you have a basic understanding of HTML forms, CSS, JavaScript, and jQuery.
-
}); }); Creating the widget Now you can start writing the code that constructs, adds and initializes the widget. This code has to be based on jQuery. Constructing the HTML A widget basically is an HTML element with certain attributes and contents. The HTML structure of a widget can be seen on the Source tab after adding the widget to a Form in the Designer. In code, reconstruct the HTML. Make sure to give the new element an ID.
-
Optionally, while initializing an element, you can make settings for this specific element. These settings get prevalence over the options already specified in the HTML and over the default settings specified in the COTG plugin. The code snippet below initializes a new Camera element (with the ID myCamera) with a number of settings: $('#myCamera').
-
addCameraWidget(cameraID); }); }); function getCameraIndex(){ return $("input.camera-dyn").length; } function addCameraWidget(cameraID, value) { if(typeof value == 'undefined') { value = ''; } var html = ''; $('#cameras').
-
Note When user of the COTG app clicks or touches the Submit button in a Form, the name and value of form elements are submitted. Normally, the name and value of an unchecked Checkbox or Radio Button would not be submitted, but in Connect, they are. Connect uses the workaround described in the following topic: "Getting the status of unchecked checkboxes and radio buttons" on page 572.
-
The below procedure describes how to use Camera data as the source of an image inside a
container. The benefit of this approach is that the image automatically scales to the size of the container. 1. Click the Insert Inline Box icon on the toolbar. The Insert Inline Box dialog appears. 2. Enter an ID for the box (anything will do, as long as it helps you identify the box) and click OK. The box is added to the text flow and can be resized if needed. 3.
-
How to use the COTG plugin is explained in the following topic: "Using the COTG plugin: cotg2.0.0.js" on page 579. To learn how to create widgets in code, see "Dynamically adding COTG widgets" on page 582 and "Saving and restoring custom data and widgets" on page 585. For a list of all COTG elements and their intended use, see "COTG Elements" on page 681. Barcode Scanner cotgBarcode() Initializing a Barcode Scanner element prepares it for user interaction. Example: $('myScanner').
-
Initialize the new Camera element with any settings that you want to be different from the defaults. Example: $('#myCamera').cotgPhotoWidget({quality: 50, height: 1024}); How to change the default settings is explained in another topic: "Changing default settings for widgets" on page 580. Option Description Type Default editimage Allows the user to edit the image after taking or selecting it.
-
Option Description Type Default allowdeskew Allows the user to perform a perspective cropping after taking or selecting a picture. Boolean false addtimestamp Adds a time stamp Boolean false stampFormat The date format. For all possible formats see Cordova documentation. 'L' stands for localized date and time.
-
Event Description clear.cotg Fired after the user has clicked the Clear button. set.cotg Fired after the user has taken or selected a picture. Date and Formatted Date cotgDatePicker() Initializing a Date or Formatted Date element prepares it for user interaction. Example: $('myDatePicker').cotgDatePicker(); Note that the difference between a Date and a Formatted Date is laid down in the HTML structure of the element. Events The Date and Formatted Date elements listen for the following custom events.
-
Events The Device Info element listens for the following event. Event Description clear.cotg Removes the Device Info data. The Device Info element broadcasts the following event. Event Description set.cotg This event is fired during initialization of the element, after setting its info to the current device. Document ID cotgDocumentId() Initializing a new Document ID puts the current Document ID in the hidden input of the element. Example: $('#myDocID').
-
Fields Table The Fields Table element itself is just a table, so it doesn't have to be initialized. However, after dynamically adding it to a Form, you still have to add the correct event handlers to the Add and Delete buttons, as follows (replace myTable by the ID of your table): $("#myTable [role=cotg-add-row-button]").on("click", function(){ $(this).closest('table').cotgAddRow(true); }); $("myTable").on("click", "[role=cotg-delete-row-button]", function (){ $(this).closest('tr').
-
Option Description Type Default maximumAge Accept a cached position if it isn't older than the specified time in milliseconds. Number 3000 timeout The maximum length of time (milliseconds) that is allowed to pass before the position is retrieved. Number 2700 Events The Geolocation element listens for the following events. Event Description clear.cotg Removes the Geolocation data. restorestate.
-
Event Description bind-toimage.cotg Bind an annotation to the picture. clear.cotg Removes any annotations. clearnote.cotg Removes any annotations. When using this element with a Camera element, trigger this event to remove annotations without removing the picture. restorestate.cotg Restores the annotations when the form is reopened in the COTG app, after the app has restored previously entered values of static input fields. savestate.cotg Saves the annotations.
-
Event Description set.cotg This event is fired during initialization of the element, after setting its value to the current locale. Repository ID cotgRepositoryId() Initializing a new Repository ID puts the current Repository ID in the hidden input of this element. The Repository ID is based on the currently logged on COTG user. Example: $('#myRepID').cotgRepositoryId(); Events The Repository ID element listens for the following custom events. Event Description clear.
-
Field Description clear.cotg Removes the signature drawing and data. draw.cotg Draws the signature on the form (e.g. after a set.cotg or restore-state.cotg event). restorestate.cotg Called when the form is reopened in the COTG app, after the app has restored previously entered values of static input fields. savestate.cotg Saves the signature data to the local storage of the COTG app. set.cotg Sets the given signature. The signature should be given as an SVG string, for example: $(“#signature”).
-
Note that the difference between a Time and a Formatted Time is laid down in the HTML structure of the element. Events The Time and Formatted Time elements listen for the following custom events. Event Description set.cotg Stores the given time (specified in a Date object). clear.cotg Removes the set time. show-timepicker.cotg Opens the Time Picker. If no time is provided (specified in a Date object), the current time will be shown.
-
Content elements Once you have created a template, it can be filled with all kinds of elements, from text to barcodes and from tables to fields on a web form. All types of elements are listed on this page. There are several ways to insert elements, see "Inserting an element" on page 607. Each element can have an ID and a class, as well as a number of other properties, depending on the element's type.
-
see "Using the Text Script Wizard" on page 780 and "Styling and formatting" on page 718. l "Hyperlink and mailto link" on page 697 l "Barcode" on page 610 l Web "Forms" on page 688 and Web "Form Elements" on page 694 l l l l "Whitespace elements: using optional space at the end of the last page" on page 471 (Print context only) "Page numbers " on page 472 (Print context only) Article, Section, Header, Footer, Nav and Aside are HTML5 semantic elements; see https://www.w3schools.
-
breadcrumbs show the HTML tag of the clicked element, as well as the HTML tags of other elements to which the clicked element belongs. The clicked element is at the end of the line. To edit the HTML text directly: l In the workspace, toggle to the Source tab. On this tab you can view and edit the content of the template in the form of plain text with HTML tags (note the angle brackets: <>). You may add and edit the text and the HTML tags, classes, ID’s and other attributes.
-
For each type of element, a small selection of attributes is visible on the Attributes pane at the top right. In a multilingual template, the proprietary data-translate attribute marks an element for translation. For more information see "Translating templates" on page 901 and "Tagging elements for translation" on page 903. Changing attributes via script Many attributes can be changed via the user interface. Another way to change attributes is by using a script.
-
4. Use the Location drop-down (if available) to select where to insert the element. l l l l l l At cursor position inserts it where the cursor is located in the template. Before element inserts it before the HTML element in which the cursor is currently located. For example if the cursor is within a paragraph, the insertion point will be before the
tag.* After start tag inserts it within the current HTML element, at the beginning, just after the start tag.
-
Tip Click the Edges button on the toolbar t emporarily adds a frame to certain elements on the Design tab. These will not .Print or output. There are two more ways to select an element in the content: l Using the Breadcrumbs at the top of the workspace. Breadcrumbs show the HTML tag of the clicked element, as well as the HTML tags of 'parent elements': elements inside of which the clicked element is located. The clicked element is at the end of the line.
-
Styling and formatting an element Format elements directly Images and other graphical elements can be resized by clicking on them and dragging the resize handles. There are toolbar buttons to color, indent or style text. Other toolbar buttons can left-align, right-align, or rotate graphical elements. The toolbar buttons only represent a selection of the formatting options for each element. There are no toolbar buttons to change an element's margins, or to add a border to it, for example.
-
Adding a Barcode Note When generating Print output, you can add extra barcodes and OMR marks. The reason why you would do this, is that at merge time more information is available about the actual output document. The page count, for example, is not available at design time. To add barcodes and OMR marks on the fly when generating Print output, select File > Print and check the option Add additional content (see "Additional Content" on page 1179) in the Print Wizard.
-
l l After element inserts it after the element in which the cursor is currently located. For example if the cursor is within a paragraph, the insertion point will be after the end tag of the paragraph (
).* Replace inserts it in place of the currently selected element. (This option is not available when inserting content in a Master Page.) * If the current element is located inside another element, use the Elements drop-down to select which element is used for the insertion location.
-
A barcode is always added with the barcode type's default properties and dimensions, but they can easily be changed; see "Barcode type and properties" below. Changing a barcode Barcode script The barcode script determines which value is fed to the barcode generator. Double-click the script on the Scripts pane to change which field or fields are added to the barcode value.
-
l Code 11, see "Code 11, Code 93, Industrial 2 of 5, Interleaved 2 of 5, Matrix 2 of 5" on page 646 l "Code 39" on page 622 l "Code 39 extended" on page 623 l Code 93, see "Code 11, Code 93, Industrial 2 of 5, Interleaved 2 of 5, Matrix 2 of 5" on page 646 l "Code 93 extended" on page 627 l "Code 128" on page 629 l "Data Matrix" on page 631 l EAN-8, EAN-13, see "UPC-A, UPC-E, EAN-8, EAN-13" on page 663 l "GS1 DataMatrix" on page 635 l "GS1-128" on page 637 l l Industrial 2 of 5, see "C
-
Australia Post, Japan Post, KIX, USPS IMb Australia Post, Japan Post, KIX and USPS IMb are some of the types of barcodes that can be added to a template; see "Barcode" on page 610. In PlanetPress Connect versions prior to 2019.2 the USPS IMb barcode was called "OneCode". The barcode can be added either using the Barcode toolbar button or through selecting Insert > Barcode on the menu; see "Adding a Barcode" on page 611. Initially the barcode will have the barcode type's default properties.
-
Color The Color group allows you to choose a different Barcode color (instead of black) and Background color (instead of white), by typing a hexadecimal color value (see for example w3school's color picker). When black is a composite of CMYK or RGB values, it may incur a color click charge on some printers. Check the Output in Grayscale option to make sure that pure black is used. Output format Defines how the barcode is output on the page. There are two possible formats: l l SVG: Vector format.
-
Configuration type Use the drop-down to select the format type used when creating the barcode: only full range format, only compact formats, or any format. Preferred configuration Use the drop-down to select the preferred format for the barcode. Note that the barcode generator may choose a different format if the data cannot be represented by the preferred format.
-
Tilde processing Check this option to process tilde characters in the data as special characters. (See the Java4less Barcodes Guide to learn what the tilde character can be used for.) Note that with this option checked, any tilde that needs to be included in the output must be escaped by adding another tilde: ~~.
-
Barcode properties This topic lists the properties of the Codabar barcode. For the properties of other barcode types, see "Barcode type and properties" on page 613. Module width Specifies the width of the narrow bars in centimeters. Changing this value to a higher value will make the barcode bigger when Scale is set to None. Start Char and Stop Char Use the drop-down to select the start and stop character for the barcode, which defines the encoding mode. Available characters are A, B, C.
-
When black is a composite of CMYK or RGB values, it may incur a color click charge on some printers. Check the Output in Grayscale option to make sure that pure black is used. Output format Defines how the barcode is output on the page. There are two possible formats: l l SVG: Vector format. This is usually of higher quality, but may take longer to generate and is not compatible with Email output. PNG: Binary rasterized format.
-
Module width Specifies the width of the narrow bars in centimeters. Changing this value to a higher value will make the barcode bigger when Scale is set to None. Scale Defines if and how the rendered barcode is scaled in relation to the parent element: l None: The barcode is rendered based on the module width. l Fit to box: The barcode is stretched to fit the parent box in both width and height.
-
l PNG: Binary rasterized format. This has a slightly lower quality than SVG but is usually generated faster and will display properly in Email output. Code 39 Code 39 is one of the barcode types that can be added to a template. The barcode can be added either using the Barcode toolbar button or through selecting Insert > Barcode on the menu; see "Adding a Barcode" on page 611. Initially the barcode will have the barcode type's default properties.
-
Add Checksum When checked, PlanetPress Connect will calculate a Checksum character and add that to the result of the Barcode script. If the value to be encoded is longer than 10 digits, a second check character will be calculated. Human Readable Message When this option is checked, PlanetPress Connect shows a human readable text below or above the barcode, as defined using the Text Position, using the specified font and font size. The font size is given in points (pt).
-
Barcode properties This topic lists the properties of the Code 39 extended barcode type. For the properties of other barcode types, see "Barcode type and properties" on page 613. Module width Specifies the width of the narrow bars in centimeters. Changing this value to a higher value will make the barcode bigger when Scale is set to None. Inter Character Gap Two adjacent characters are separated by an inter-character gap.
-
Human Readable Message When this option is checked, PlanetPress Connect shows a human readable text below or above the barcode, as defined using the Text Position, using the specified font and font size. The font size is given in points (pt). Color The Color group allows you to choose a different Barcode color (instead of black) and Background color (instead of white), by typing a hexadecimal color value (see for example w3school's color picker).
-
Barcode properties This topic lists the properties of the following barcode types : l Code 11 l Code 93 l Industrial 2 of 5 l Interleaved 2 of 5 l Matrix 2 of 5 For the properties of other barcode types, see "Barcode type and properties" on page 613. Module width Specifies the width of the narrow bars in centimeters. Changing this value to a higher value will make the barcode bigger when Scale is set to None.
-
Color The Color group allows you to choose a different Barcode color (instead of black) and Background color (instead of white), by typing a hexadecimal color value (see for example w3school's color picker). When black is a composite of CMYK or RGB values, it may incur a color click charge on some printers. Check the Output in Grayscale option to make sure that pure black is used. Output format Defines how the barcode is output on the page. There are two possible formats: l l SVG: Vector format.
-
Scale Defines if and how the rendered barcode is scaled in relation to the parent element: l None: The barcode is rendered based on the module width. l Fit to box: The barcode is stretched to fit the parent box in both width and height. Add Checksum When checked, PlanetPress Connect will calculate a Checksum character and add that to the result of the Barcode script. If the value to be encoded is longer than 10 digits, a second check character will be calculated.
-
l l SVG: Vector format. This is usually of higher quality, but may take longer to generate and is not compatible with Email output. PNG: Binary rasterized format. This has a slightly lower quality than SVG but is usually generated faster and will display properly in Email output. Code 128 Code 128 is one of the types of barcodes that can be added to a template; see "Barcode" on page 610.
-
Scale Defines if and how the rendered barcode is scaled in relation to the parent element: l None: The barcode is rendered based on the module width. l Fit to box: The barcode is stretched to fit the parent box in both width and height. Tilde processing Check this option to process tilde characters in the data as special characters. (See the Java4less Barcodes Guide to learn what the tilde character can be used for.
-
Data Matrix Data Matrix is one of the types of barcodes that can be added to a template; see "Barcode" on page 610. The barcode can be added either using the Barcode toolbar button or through selecting Insert > Barcode on the menu; see "Adding a Barcode" on page 611. Initially the barcode will have the barcode type's default properties.
-
Encoding The data represented in the symbol can be compressed using of the following algorithms. l ASCII is used to encode data that mainly contains ascii characters (0-127) l C40 is used to encode data that mainly contains numbers and uppercase characters. l Text is used to encode data that mainly contains numbers and lowercase l Base256 is used to encode 8 bit values l l Auto Detect automatically detects the data content and encodes using the most appropriate method.
-
When black is a composite of CMYK or RGB values, it may incur a color click charge on some printers. Check the Output in Grayscale option to make sure that pure black is used. Output format Defines how the barcode is output on the page. There are two possible formats: l l SVG: Vector format. This is usually of higher quality, but may take longer to generate and is not compatible with Email output. PNG: Binary rasterized format.
-
Show guardbars Checking this option adds guardbars to the barcode. Guardbars are bars at the start, in the middle and at the end that help the barcode scanner to scan the barcode correctly. Scale Defines if and how the rendered barcode is scaled in relation to the parent element: l None: The barcode is rendered based on the module width. l Fit to box: The barcode is stretched to fit the parent box in both width and height.
-
Color The Color group allows you to choose a different Barcode color (instead of black) and Background color (instead of white), by typing a hexadecimal color value (see for example w3school's color picker). When black is a composite of CMYK or RGB values, it may incur a color click charge on some printers. Check the Output in Grayscale option to make sure that pure black is used. Output format Defines how the barcode is output on the page. There are two possible formats: l l SVG: Vector format.
-
Barcode properties This topic lists the properties of the barcode type GS1 DataMatrix. For the properties of other barcode types, see "Barcode type and properties" on page 613. Module width Specifies the width of the narrow bars in centimeters. Changing this value to a higher value will make the barcode bigger when Scale is set to None. Preferred format Use the drop-down to select the size of the Data Matrix.
-
l ~1 = FNC1 character (for GS1 DataMatrix barcodes) l ~2 = Structure Append l ~3 = Reader programming l ~5 = Macro5 l ~6 = Macro6 l ~7 = ECI expressions Human Readable Message When this option is checked, PlanetPress Connect shows a human readable text below or above the barcode, as defined using the Text Position, using the specified font and font size. The font size is given in points (pt).
-
The barcode can be added either using the Barcode toolbar button or through selecting Insert > Barcode on the menu; see "Adding a Barcode" on page 611. Initially the barcode will have the barcode type's default properties. To change those properties, such as the scale and color, open the Barcode properties dialog: right-click the barcode (on the Design tab in the Workspace) and select the Barcode... option in the context menu. Barcode properties This topic lists the properties of the barcode type GS1-128.
-
Human Readable Message When this option is checked, PlanetPress Connect shows a human readable text below or above the barcode, as defined using the Text Position, using the specified font and font size. The font size is given in points (pt). Color The Color group allows you to choose a different Barcode color (instead of black) and Background color (instead of white), by typing a hexadecimal color value (see for example w3school's color picker).
-
Barcode properties This topic lists the properties of the following barcode types : l Code 11 l Code 93 l Industrial 2 of 5 l Interleaved 2 of 5 l Matrix 2 of 5 For the properties of other barcode types, see "Barcode type and properties" on page 613. Module width Specifies the width of the narrow bars in centimeters. Changing this value to a higher value will make the barcode bigger when Scale is set to None.
-
Color The Color group allows you to choose a different Barcode color (instead of black) and Background color (instead of white), by typing a hexadecimal color value (see for example w3school's color picker). When black is a composite of CMYK or RGB values, it may incur a color click charge on some printers. Check the Output in Grayscale option to make sure that pure black is used. Output format Defines how the barcode is output on the page. There are two possible formats: l l SVG: Vector format.
-
l Industrial 2 of 5 l Interleaved 2 of 5 l Matrix 2 of 5 For the properties of other barcode types, see "Barcode type and properties" on page 613. Module width Specifies the width of the narrow bars in centimeters. Changing this value to a higher value will make the barcode bigger when Scale is set to None. Scale Defines if and how the rendered barcode is scaled in relation to the parent element: l None: The barcode is rendered based on the module width.
-
Output format Defines how the barcode is output on the page. There are two possible formats: l l SVG: Vector format. This is usually of higher quality, but may take longer to generate and is not compatible with Email output. PNG: Binary rasterized format. This has a slightly lower quality than SVG but is usually generated faster and will display properly in Email output.
-
l Bar width: The width of the bars. l Spacing: The distance between the bars. Scale Defines if and how the rendered barcode is scaled in relation to the parent element: l l None: The barcode is rendered based on the module width. Proportional: The barcode is stretched up to where it fits either the width or height of the parent box, whichever requires the less stretching.
-
Initially the barcode will have the barcode type's default properties. To change those properties, such as the scale and color, open the Barcode properties dialog: right-click the barcode (on the Design tab in the Workspace) and select the Barcode... option in the context menu. Note that barcodes of these types don't process tilde characters (~) in the data as special characters. Barcode properties This topic lists the properties of the barcode types Australia Post, Japan Post, KIX and UPS IMb.
-
Output format Defines how the barcode is output on the page. There are two possible formats: l l SVG: Vector format. This is usually of higher quality, but may take longer to generate and is not compatible with Email output. PNG: Binary rasterized format. This has a slightly lower quality than SVG but is usually generated faster and will display properly in Email output.
-
Module width Specifies the width of the narrow bars in centimeters. Changing this value to a higher value will make the barcode bigger when Scale is set to None. Scale Defines if and how the rendered barcode is scaled in relation to the parent element: l None: The barcode is rendered based on the module width. l Fit to box: The barcode is stretched to fit the parent box in both width and height.
-
l PNG: Binary rasterized format. This has a slightly lower quality than SVG but is usually generated faster and will display properly in Email output. MaxiCode MaxiCode is one of the barcode types that can be added to a template; see "Barcode" on page 610. The barcode can be added either using the Barcode toolbar button or through selecting Insert > Barcode on the menu; see "Adding a Barcode" on page 611. Initially the barcode will have the barcode type's default properties.
-
w3school's color picker). When black is a composite of CMYK or RGB values, it may incur a color click charge on some printers. Check the Output in Grayscale option to make sure that pure black is used. MSI MSI is one of the types of barcodes that can be added to a template; see "Barcode" on page 610. The barcode can be added either using the Barcode toolbar button or through selecting Insert > Barcode on the menu; see "Adding a Barcode" on page 611.
-
Add Checksum When checked, PlanetPress Connect will calculate a Checksum character and add that to the result of the Barcode script. If the value to be encoded is longer than 10 digits, a second check character will be calculated. Checksum Type The Checksum type can be MSI10, MSI11, MSI1010 or MSI1110; see https://en.wikipedia.org/wiki/MSI_Barcode.
-
The barcode can be added either using the Barcode toolbar button or through selecting Insert > Barcode on the menu; see "Adding a Barcode" on page 611. Initially the barcode will have the barcode type's default properties. To change those properties, such as the scale and color, open the Barcode properties dialog: right-click the barcode (on the Design tab in the Workspace) and select the Barcode... option in the context menu. Barcode properties This topic lists the properties of the barcode type PDF417.
-
Compact Check this option to use Compact PDF417 instead of the PDF417 barcode. This shortened form of the PDF417 barcode is useful where the space for the symbol is restricted. Scale Defines if and how the rendered barcode is scaled in relation to the parent element: l None: The barcode is rendered based on the module width. l Fit to box: The barcode is stretched to fit the parent box in both width and height.
-
POSTNET POSTNET is one of the barcode types that can be added to a template; see "Barcode" on page 610. The barcode can be added either using the Barcode toolbar button or through selecting Insert > Barcode on the menu; see "Adding a Barcode" on page 611. Initially the barcode will have the barcode type's default properties. To change those properties, such as the scale and color, open the Barcode properties dialog: right-click the barcode (on the Design tab in the Workspace) and select the Barcode...
-
Human Readable Message When this option is checked, PlanetPress Connect shows a human readable text below or above the barcode, as defined using the Text Position, using the specified font and font size. The font size is given in points (pt). Color The Color group allows you to choose a different Barcode color (instead of black) and Background color (instead of white), by typing a hexadecimal color value (see for example w3school's color picker).
-
Barcode properties This topic lists the properties of the QR barcode. For the properties of other barcode types, see "Barcode type and properties" on page 613. Module size Enter the size of the square modules in pixels. Auto configure When this option is checked, the barcode generator overwrites the selected Preferred version (see below) and defines the barcode version based on the supplied data. Preferred version There are 40 sizes of QR codes. Select the preferred version for the QR code.
-
FNC Use the drop-down to either disable FNC or select a FNC option: l l First: This mode indicator identifies symbols encoding data formatted according to the UCC/EAN Application Identifiers Second: This mode indicator identifies symbols formatted in accordance with specific industry or application specifications previously agreed with AIM International. You must then set a value for the Application Indicator property.
-
l l SVG: Vector format. This is usually of higher quality, but may take longer to generate and is not compatible with Email output. PNG: Binary rasterized format. This has a slightly lower quality than SVG but is usually generated faster and will display properly in Email output. Barcode Data QR Codes can have many different types of data, which determines how the code will be generated.
-
Preferred version Use the drop-down to select the size of the barcode, in a number of modules. The actual size of the barcode can be 12 mm x 12 mm up to 22.4 mm x 22.4 mm, depending on the preferred version and the module width. Scale Defines if and how the rendered barcode is scaled in relation to the parent element: l l None: The barcode is rendered based on the module width.
-
Royal Mail 4-State (CBC) Royal Mail 4-State (CBC) is one of the types of barcodes that can be added to a template; see "Barcode" on page 610. In PlanetPress Connect versions prior to 2019.2 this barcode was called "Royal Mail 4 State (RM4SCC)". The barcode can be added either using the Barcode toolbar button or through selecting Insert > Barcode on the menu; see "Adding a Barcode" on page 611. Initially the barcode will have the barcode type's default properties.
-
Add Checksum When checked, PlanetPress Connect will calculate a Checksum character and add that to the result of the Barcode script. If the value to be encoded is longer than 10 digits, a second check character will be calculated. Human Readable Message When this option is checked, PlanetPress Connect shows a human readable text below or above the barcode, as defined using the Text Position, using the specified font and font size. The font size is given in points (pt).
-
Initially the barcode will have the barcode type's default properties. To change those properties, such as the scale and color, open the Barcode properties dialog: right-click the barcode (on the Design tab in the Workspace) and select the Barcode... option in the context menu. Barcode properties This topic lists the properties of the barcode types Royal Mail 4-State Mailmark C and Royal Mail 4-State Mailmark L. For the properties of other barcode types, see "Barcode type and properties" on page 613.
-
When black is a composite of CMYK or RGB values, it may incur a color click charge on some printers. Check the Output in Grayscale option to make sure that pure black is used. Output format Defines how the barcode is output on the page. There are two possible formats: l l SVG: Vector format. This is usually of higher quality, but may take longer to generate and is not compatible with Email output. PNG: Binary rasterized format.
-
Scale Defines if and how the rendered barcode is scaled in relation to the parent element: l l None: The barcode is rendered based on the module width. Proportional: The barcode is stretched up to where it fits either the width or height of the parent box, whichever requires the less stretching. Human Readable Message When this option is checked, PlanetPress Connect shows a human readable text below or above the barcode, as defined using the Text Position, using the specified font and font size.
-
Initially the barcode will have the barcode type's default properties. To change those properties, such as the scale and color, open the Barcode properties dialog: right-click the barcode (on the Design tab in the Workspace) and select the Barcode... option in the context menu. Note that these barcode types process tilde characters in the data as special characters. See the Java4less Barcodes Guide to learn what the tilde character can be used for.
-
Note When the chosen supplement type doesn't match the data, the supplement data will be skipped and the additional barcode will not be rendered. l l Height Factor: This is the relative height of the supplement's bars compared to the normal bars. Space Before : Defines the space between the main symbol and the supplement, in cm.
-
In PlanetPress Connect versions prior to 2019.2 the USPS IMb barcode was called "OneCode". The barcode can be added either using the Barcode toolbar button or through selecting Insert > Barcode on the menu; see "Adding a Barcode" on page 611. Initially the barcode will have the barcode type's default properties. To change those properties, such as the scale and color, open the Barcode properties dialog: right-click the barcode (on the Design tab in the Workspace) and select the Barcode...
-
Color The Color group allows you to choose a different Barcode color (instead of black) and Background color (instead of white), by typing a hexadecimal color value (see for example w3school's color picker). When black is a composite of CMYK or RGB values, it may incur a color click charge on some printers. Check the Output in Grayscale option to make sure that pure black is used. Output format Defines how the barcode is output on the page. There are two possible formats: l l SVG: Vector format.
-
Color The Color group allows you to choose a different Barcode color (instead of black) and Background color (instead of white), by typing a hexadecimal color value (see for example w3school's color picker). When black is a composite of CMYK or RGB values, it may incur a color click charge on some printers. Check the Output in Grayscale option to make sure that pure black is used. Output format Defines how the barcode is output on the page. There are two possible formats: l l SVG: Vector format.
-
Positioned Box A Positioned Box is one that can be freely moved around the page and does not depend on the position of other elements. A positioned box is actually a
element that has an absolute position; in other words, it has its CSS property position set to absolute (see also: "Using the CSS position property" on page 738). Positioned Boxes are suitable for use in Print templates only. Adding a Positioned Box To insert a Positioned Box, use the icon on the toolbar.
-
Note Do not set the top or left property of a Positioned Box in a style sheet. The position of a Positioned Box in a Print context is handled via its attributes to take the page (or Master Page) and page margins into account. Attributes cannot be overwritten from within a style sheet: style sheets specify style properties, not values of attributes.
-
l l The Float rightbutton aligns the Inline Box to the right, with the text wrapped around it to the left. The No float button positions the Inline Box where it occurs in the text. It is not possible to move an Inline Box using drag and drop. To move the Inline Box to another position in the text, you have to edit the HTML on the Source tab in the Workspace, moving the
element using cut and paste. To open the Source tab, click it (at the bottom of the Workspace) or select View > Source View.
-
the Designer; see "Editing HTML" on page 605. In HTML, boxes are
elements. Spans are
elements. To learn how to change the attributes of elements, see "Attributes" on page 606. Business graphics Business graphics are a great way to visualize data in your documents. Connect Designer lets you create three types of grapics: Bar Charts, Line Charts and Pie Charts. The charts are generated by the integrated amCharts library (https://www.amcharts.com/javascript-charts/).
-
To insert a business graphic in a template: 1. Place the cursor where the graphic should be added. Also make sure that you have loaded data or a data mapping configuration (see "Loading data" on page 765). 2. Click the toolbar button of the type of chart you want to add, or select Insert > Business graphic and choose the chart type. The wizard opens with a page on which you can specify the attributes and insertion point of the graph. 3. An ID is required.
-
5. Click Next and specify the data for the graph. These settings can also be edited when you open the script, after you've inserted the chart. For an explanation of the options in the wizard, see "Selecting data for a Business Graphic" on the next page. 6. For a Bar Chart or Line Chart, you can click Next and set some basic parameters of the chart: l l l Stack Series: Check to stack the values in one bar, instead of having one bar per value. This is only useful with a chart that is based on a data table.
-
To rasterize a business graphic, right-click it and select Rasterize Options. For a JPG image you can set the quality of the resulting image in a percentage. Note A business graphic in an Email section is rasterized by default and output as PNG image, because email clients usually don't support SVG images. SVG images in an Email section give an error in the Preflight window (see "Doing a Preflight" on page 855).
-
2. For a Bar or Line Chart based on a detail table, you also have to select a Category: one data field (in the detail table) of which the values will appear under the bars or the line; in other words, on the x axis. 3. Next to Values, select data fields with a numerical value. Tip The Toggle non-numeric fields button filters non-numeric fields from the list. The list will then display only Integer, Float and Currency data fields. 4.
-
Preparing a data table By default, a chart that is based on a detail table shows one series ("category") of bars/points per record. Each of the bars or points in a series has its own color and label, and represents one data field in that record. The following image shows a detail table. Both of the Bar charts below are based on that detail table. The difference between the Bar charts is caused by the number of selected data fields (one, or two).
-
to modify the detail table in the data mapping configuration in order to make it match the default approach. Otherwise this requires changing the Chart script: open the Chart script, click the Expand button, and alter the code that puts data in the dataProvider property. Note How to create a Pie Chart that has one slice per detail record is explained in a How-to: Put one slice per detail record in a Pie Chart. In Connect versions up to 1.
-
On the Source tab, all settings are given in JSON. For example: { "type": "pie", "legend": { "enabled": false }, "radius": "100", "innerRadius": "30" } (The innerRadius option, found on the Pie tab in the Pie Chart properties, gives this Pie Chart the shape of a donut.) Note that only properties that were modified via one of the tab menus are included in the JSON on the Source tab. To change the chart, you can simply edit the JSON.
-
For inspiration you could use amCharts' online editor: https://live.amcharts.com/new/. Properties can be copied directly from the Code tab in the live editor to the Source tab of the Chart properties dialog in Connect. Note that copying the entire content of the Code tab will also carry over the sample data from the live editor (the dataProvider key). These will be overwritten by the chart script in Connect.
-
C. On the Background tab, set the Color to: l #282828 for the 'dark' theme and the 'chalk' theme l #222222 for the 'black' theme 3. Finally, the 'chalk' theme requires adding a remote stylesheet with this URL: 'https://fonts.googleapis.com/css?family=Covered+By+Your+Grace' to your template. See "Using a remote style sheet" on page 722. COTG Elements With the Designer you can create Capture OnTheGo templates. COTG templates are used to generate forms for the Capture OnTheGo mobile application.
-
When the form is submitted, the image is sent in a base64-encoded string format. To learn how to add Camera data to a template, see "Adding Camera data to the template" on page 548. The Camera element has a number of options, of which most can be set in the Design view. These options are described below. All options, including options that cannot be set via the Design view, can be set via the Source view or in code; see "Changing default settings for widgets" on page 580.
-
Cropping/editing/deskewing To allow the user to crop, edit and deskew the image after taking or selecting it, select Camera properties, and then check Edit Image and/or Allow Deskew. Which editing options the user actually gets and how they are presented to the user depends on the operating system of the device. On an Android device for example, the user may be able only to crop the image, while the user of an iOS device may select part of the image and rotate that selection.
-
1. Load the data mapping configuration (or at least the data model). 2. Insert a dummy image in the template. 3. Right-click the dummy image and select Dynamic Image. The Text Script Wizard appears. 4. Under Field select the field that contains the base64-encoded string. The script puts the given string in the source (src) attribute of the image (
). Instead of using the Text Script Wizard, you could also write a script yourself; see "Writing your own scripts" on page 843.
-
Fields Table The Fields Table element adds a table with two rows, a Delete button at the end of the first row and an Add button at the end of the second row. Inside the rows you can put whatever elements you need. The user can click (or rather, touch) the Add button to add a row to the table. The new row will contain the same elements as the first row. The names of all elements in the first row will be extended with __0, while the names of the elements in the second row will be extended with __1, etc.
-
the Image & Annotation element, followed by "-note-data", for example image_annotation1note-data. Locale The Locale Element does not have a UI element in the form. Inserting it adds a hidden input field that will contain the device's set locale when the form is submitted. This data is sent in plain text format and is available when processing the form data. The format is defined by the device.
-
the locale of the device on which the user is viewing the form. A Time Element displays dates in the ISO 8601 format: HH:MM. When the form is submitted, the time data is sent as plain text. A Formatted Time element submits the time in both the ISO format mentioned above and in the format that depends on the device's regional and language settings. A Time element sends the time in the ISO format only.
-
Changing the date Once inserted, a date can be modified directly in the template (if it does not update automatically) or through the date script (if it does update automatically). To modify the date in the script: 1. Double-click the date script in the Scripts pane. 2. Between the round brackets after Date, enter the desired date in the following order: year, month, day, and optionally hours, minutes, seconds, milliseconds (see https://www.w3schools.com/js/js_dates.asp and https://developer.mozilla.
-
Tip To create a Capture OnTheGo template, preferably use a Template Wizard (see "Capture OnTheGo template wizards" on page 553). The Wizard doesn't just add the form, it also adds the necessary Capture OnTheGo form elements (see "COTG Elements" on page 681), style sheets and JavaScript files, and extra pre-made elements. Adding a Form This procedure describes how to add a Form element to an existing Web context. 1. On the Resources pane, expand the Web context and double-click a Web page to open it. 2.
-
l l l application/x-www-form-urlencoded: Default. All characters are encoded before they are sent. Spaces are converted to "+" symbols, and special characters are converted to ASCII HEX values. multipart/form-data: No characters are encoded. This value is required when you are using forms that have a file upload control. text/plain: Spaces are converted to "+" symbols, but no special characters are encoded. 7.
-
l l l l l l At cursor position inserts it where the cursor is located in the template. Before element inserts it before the HTML element in which the cursor is currently located. For example if the cursor is within a paragraph, the insertion point will be before the
tag.* After start tag inserts it within the current HTML element, at the beginning, just after the start tag.* Before end tag inserts it within the current HTML element, at the end, just before the end tag.
-
l l l l The ID and/or class. ID's and classes are particularly useful with regard to variable data (see "Personalizing content" on page 762) and styling (see "Styling templates with CSS files" on page 719). An Action: the URL where the form data should be sent. The URL should be a server-side script that can accept form data (a Workflow process that starts with a Server Input task, for example). A Method: this defines whether the form should be sent using the GET or POST method.
-
l l l l Required: Check if the field is required to submit the form. If a field is required but contains no data, a message will be shown to the user. Minimum length: Enter a numerical value for the minimum character length required for this field. Maximum length: Enter a numerical value for the minimum character length accepted for this field. Equal to: Use the drop-down to select another field that is already added to the same Form. The contents of both fields must match for the data to be validated.
-
Form Elements This topic lists the elements that can be added to a form in a Web page or in a Capture OnTheGo template and explains how to add them to a Form, set a default value or change their validation. For more information about Forms and Form elements in the Designer, see "Forms" on page 688 and "Using Form elements" on page 532. For more information about elements in Forms, see https://www.w3schools.com/html/html_ forms.asp. Fieldset A fieldset is a group of related elements in a form.
-
Date The Date element is a text field accepting only dates in a valid format. Text area The Text area element is a text field accepting multiple paragraphs. You can set a number of rows when adding the Text Area to the Form, and change it on the Attributes pane. Hidden field A hidden field can contain specific data used by the server-side script. It is not visible to the user. When adding a Hidden Field you can set the value that will be sent on submit.
-
The option to add a Radio Button Group is only available in the Form Wizard; see "Forms" on page 688. For an explanation of the options in the Radio Button Group dialog, see "Adding elements to a Form" on page 532. You could also create a Radio Button Group by specifying the same submit name for a number of Radio Buttons when adding them to a Form. Radio Button A radio button sends information to the server whether it is selected (true) or not (false).
-
A reset button will reset the form to its original configuration, erasing any information entered and options provided. Note: This cannot be undone! The button's type can also be changed on the Attributes pane. l There may be multiple submit buttons on a Form. If this is the case, specify a different name and/or value for each of the buttons. Note: When adding a Button to a Form, you can specify a value, but no name. The Button's ID will be copied to the element's name attribute.
-
Adding a hyperlink or mailto link 1. Select text or an image. Note Although it is possible, it is not advisable to add a Hyperlink to other elements, such as a Paragraph or Div. HTML 4 specifies that hyperlinks and mailto-links may only contain inline elements. Block elements, such as a Div, may not appear inside a link. HTML 5 states that the link "may be wrapped around entire paragraphs, lists, tables, and so forth, even entire sections, so long as there is no interactive content within (e.g.
-
For a mailto link: l l l Email: enter a valid email address that appears by default in the To: field of the email client. Subject: type a default subject that appears in the Subject: field of the email client. Message: type a message that appears by default in the Message field of the email client. Note that all these can be changed within the email client once the link is clicked. Tip To quickly change the text of a hyperlink, position the cursor on the link and click ~contents in the Breadcrumbs.
-
l EPS l GIF l JPG/JPEG l PCL l PDF l PNG l PS l SVG l TIF/TIFF Base64 encoded images are supported; however, they are added differently: set the src attribute of an
element to the base64 code (see below, "Images" on the previous page). For Email and Web output, PNG is the preferred image format. EPS, PDF, SVG and TIFF images in an Email or Web section are automatically converted to PNG to ensure that they can be seen in the browser or email client.
-
Background images Several parts of templates, such as sections and media, and elements such as positioned boxes, can have a background image. Right-click the element and click the Background tab to select an image to be used as the element's background image. See "Background color and/or image" on page 748 and "Using a PDF file or other image as background" on page 464.
-
Adding images This section explains the difference between imported and external images and describes a number of ways to add images to a template. Note The Connect image cache size is limited to 100MB. This allows most output jobs to run faster. However, if a job requires more than 100MBs of image files, then the Connect image cache size can be increased to cater for such. Please contact OL Support for instructions on how to modify the image memory cache value, if needed.
-
extension, you have to add the filetype parameter to the URL manually. Specify the file extension as its value, for example: ?filetype=pdf, or &filetype=pdf if it isn't the first parameter. Note that the ampersand character needs to be encoded as &. For information about referring to images in HTML or in a script, see "Resources" on page 438. Via drag-and-drop The drag-and-drop method is a quick way to import one or more images into a template. 1.
-
in file:///, for example: file:///c:/resources/images/image.jpg. l Url lists image files from a specific web address. Select the protocol (http or https), and then enter a web address (for example, http://www.mysite.com/images/image.jpg).
-
Importing images from another template To import images directly from another template, click File > Import Resources... in the menu. See: "Import Resources dialog" on page 937. Using one file that contains a collection of images (a 'sprite') When a template that contains lots of images is merged with a large record set, the many file requests may slow down the process of output generation.
-
Images can be styled using the same dialog, or through the CSS files; see "Styling templates with CSS files" on page 719. A number of issues related to image styling are discussed in a separate topic: "Styling an image" on page 745. Just like many other elements, images can be given borders and rounded corners, they can have inner and outer margins and they can be rotated. How to do this is described in general formatting topics, such as "Border" on page 749 and "Spacing" on page 761.
-
Note When CSS repeating gradients are displayed in a PDF reader, artifacts, like very thin lines may occur. When this happens, try setting the gradient's position a little bit different. Table Tables serve two different purposes: they are a way to display data in a tabular format, and they are also a way to position elements on a page. In HTML email, Tables are the most reliable way to position text and images; see "Designing an Email template" on page 490.
-
Inserting a Table 1. On the toolbar, click the Insert Table button, or on the menu select Insert > Table > Standard. 2. Enter the Table's desired attributes: l l ID: a unique identifier for the Table. IDs are used to access the Table from scripts and as CSS selectors for style rules. Class: A class identifier for the Table. Classes can be shared between elements and are used to access the Table from scripts and as CSS selectors for style rules.
-
when you insert a Div into a paragraph, the paragraph gets split in two. This means you end up with two paragraphs with the Div in between. Note l l Tables with an absolute position are only useful in Print sections. Tables on a Master Page have to have an absolute position, unless they are located inside another element with an absolute position. 4. Click Next and select the desired table style. The top left actually applies no styling to the table.
-
Rows and columns Adding a row or column To add a row or column to an existing Table, click in a cell. Then click the black triangle next to the Insert Row Above button on the toolbar, and click one of the Insert buttons, or select one of the options in the Insert > Table Elements menu. Alternatively, right-click the Table and on the shortcut menu, select Row > Insert Above or Insert Below, or select Column > Insert Before or Insert After.
-
Resizing and moving a Table Resizing a Table l l l Select the Table (see "Selecting an element" on page 608) and type the desired width and height under Geometry on the Attributes pane. Select the Table and select Format > Table, on the menu. On the Table tab, change the width and height of the Table. Click in the Table and drag the handles to resize it. Press the Shift key while dragging to scale the Table proportionally.
-
Hiding the border When using a Table to position other elements, you will want to hide the borders of the Table. To do this, set the width of the border to 0; see "Border" on page 749. Text and special characters The vast majority of templates for personalized customer communications contain, of course, text. While the most common text element is a
or paragraph, other elements such as Headings (
through ) are also considered text elements.
-
This how-to describes another way to maintain extra spaces in the text: Maintain extra spaces in text. Adding special characters To add special characters: 1. Position the cursor where the character should be inserted. 2. On the Insert menu, point to Special Characters click Symbols, Dashes and Spaces, Arrows, or Geometric Shapes, and click one of the available special characters. Adding page numbers Page numbers can only be used in the Print context. See "Page numbers " on page 472.
-
Translating text OL Connect templates can be multilingual. For information about multilingual templates and how to create them, see "Translating templates" on page 901. Snippets A snippet is a small, ready-to-use piece of content in a file. Snippets can be re-used within the same template, in all contexts and sections. They can contain any contents that a section can have, such as text, images, variable data, dynamic tables, etc. Normally, a snippet is an HTML file, but it can also be a JSON file.
-
Adding a snippet to the Resources Before adding a snippet: l l Import the resource files that are related to the snippet, such as image files and CSS files, into the template file. Drag and drop the files to the corresponding folders (Images and Stylesheets, respectively) on the Resources pane. If you want to use external images, see "Images" on page 699.
-
Adding a snippet to a section Drag-and-drop To add the snippet to the content of a section, drag the snippet from the Snippets folder on the Resources pane to the desired location in a section. Check the option Insert as shared content to insert a reference to the original snippet in the template, rather than a copy of the original snippet.
-
The option to modify shared content snippets from within a section can be turned off: l l In the menu, select View > Shared Content Editing to enable or disable editing of all shared content. To enable or disable editing on a case by case basis, you can also manually set the contenteditable attribute on the Article element of the shared content to true or false. This overrides the menu setting. Note Remote snippets inserted as shared content cannot be changed from within the Designer.
-
Styling and formatting In the Designer you have everything at hand to make your templates look good: colors, fonts and all the tools to position, align and embellish elements in your designs. This topic informs about the ways to style a template. Local formatting versus style sheets There are in general two ways to style elements: l l Using local formatting. Local formatting means styling an element directly, using a toolbar button or one of the formatting dialogs. Using Cascading Style Sheets (CSS).
-
Text and paragraphs have a number of formatting options that are not available for other elements: font styles and line height, for example. See "Styling text and paragraphs" on page 731. Boxes and a number of other elements can have a background color and/or background image; see "Background color and/or image" on page 748. Several elements, such as boxes, images, paragraphs, and tables, can have a border; see "Border" on page 749.
-
template itself, you can define a layout for all paragraphs, and for all output channels, in a CSS file. The benefit of this is that you can quickly and easily change the look and feel of all contexts in one template, without having to change the contents. In the event that your company chooses to use another font or to adjust its corporate colors, you only have to change the style sheets.
-
l l l One style sheet that applies to all document types: context_all_styles.css. One or more style sheets specific to the context (Print, Email, Web). For example, when you create an action email using the Wizard, the files context_htmlemail_styles.ccs and basic_email_action.css are automatically added to the Stylesheets folder on the Resources pane. A style sheet that defines default styles for tables: default.css.
-
Tip l l To export a CSS file from your template, drag or copy/paste it out of the Stylesheets folder to a folder on the local hard drive. It is possible to open and edit any CSS file in the Designer: select File > Open, select All files (*.*) as the file type and then select a CSS file. Using a remote style sheet A remote style sheet is not located within your template but is located in a network folder or hosted on an external web server (generally called a CDN).
-
Tip After adding the remote file, you may right-click it and select Download Resource. This allows you to maintain a central file, from which you can quickly download a copy to your template without having to copy & paste. Note that a local copy of a remote resource is a snapshot; it is not automatically kept in sync with its remote content. You can download the remote resource again to overwrite the local copy with updated content.
-
Styling your templates with CSS files Note Email clients do not read CSS files and some even remove a